Skip to content
All guides

Windsurf + agentdocs

Windsurf MCP entry. Publish docs from Cascade; sync .windsurfrules across projects.

2 min readGuide

Install the MCP server

Add to ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "agentdoc": {
      "command": "npx",
      "args": ["-y", "@agentdoc/mcp"]
    }
  }
}

Restart Windsurf. First run provisions an anonymous API key at ~/.agentdoc/mcp-key.json — no email, no OAuth.

What Cascade can do once connected

"Publish this architecture doc as arch/event-pipeline." "Fetch the latest runbook and open it alongside the code." "Create an AgentDoc for the migration plan and invite the backend team."

Cascade creates, updates, publishes, forks, and searches via MCP.

Sync .windsurfrules across repos

agentdoc init
agentdoc track .windsurfrules --slug windsurf-rules-acme
agentdoc push

# Any other repo
agentdoc init
agentdoc track .windsurfrules --slug windsurf-rules-acme
agentdoc pull
  • agentdoc status → synced / behind / modified.
  • agentdoc pull → latest version lands in place.
  • agentdoc watch .windsurfrules windsurf-rules-acme → auto-push on save.

One doc, many tools

The same AgentDoc can feed every AI tool's rules file:

agentdoc track .windsurfrules --slug team-ai-rules
agentdoc track .cursorrules --slug team-ai-rules
agentdoc track .github/copilot-instructions.md --slug team-ai-rules
agentdoc pull

Write your conventions once. Every tool reads the same markdown.

Quick start

echo '{"mcpServers":{"agentdoc":{"command":"npx","args":["-y","@agentdoc/mcp"]}}}' > ~/.codeium/windsurf/mcp_config.json
# Restart Windsurf. Ask Cascade: "Publish this doc as architecture/overview."