Skip to main content

Windsurf Integration

Connect Json2doc with Windsurf (formerly Cascade) by Codeium to generate documents while coding.

Prerequisites​

Configuration​

In Windsurf:

  1. Open Settings (Cmd/Ctrl + ,)
  2. Search for "MCP" or navigate to MCP Server settings
  3. Add the Json2doc MCP server:
{
  "mcpServers": {
    "json2doc": {
      "serverUrl": "https://mcp.json2doc.com/mcp",
      "headers": {
        "x-api-key": "your-api-key-here"
      }
    }
  }
}
warning

Replace your-api-key-here with your actual Json2doc API key from app.json2doc.com → Settings → API Keys.

After saving, reload Windsurf (Cmd/Ctrl + Shift + P → "Reload Window")

Verification​

To verify the integration is working:

  1. Open the Cascade chat panel
  2. Ask: "What Json2doc tools are available?"
  3. Cascade should list the Json2doc capabilities

Troubleshooting​

Windsurf Doesn't Recognize Json2doc​

Solutions:

  • Check the MCP configuration is saved correctly
  • Verify JSON syntax is valid
  • Reload Windsurf window
  • Verify the API key is correct

Authentication Errors​

Solutions:

  • Verify API key in dashboard
  • Check for extra spaces in configuration
  • Ensure key hasn't expired
  • Generate a new key if needed

Connection Issues​

Solutions:

  • Verify the URL: https://mcp.json2doc.com/mcp
  • Check internet connection
  • Ensure firewall allows the connection
  • Try restarting Windsurf