diff --git a/docs/.vale/styles/config/vocabularies/Suga/accept.txt b/docs/.vale/styles/config/vocabularies/Suga/accept.txt index d74d843..053cd61 100644 --- a/docs/.vale/styles/config/vocabularies/Suga/accept.txt +++ b/docs/.vale/styles/config/vocabularies/Suga/accept.txt @@ -32,6 +32,7 @@ resource_group_name storage_account_name container_name tfstatestorage +mcpServers # Defaults from mintlify Mintlify diff --git a/docs/docs.json b/docs/docs.json index 5d7eb2e..43767fb 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -30,6 +30,7 @@ "pages": [ "guides", "guides/add-suga", + "guides/mcp-integration", "guides/build-platform", "guides/database-migration", "guides/terraform-backend-config", diff --git a/docs/guides.mdx b/docs/guides.mdx index 885ca1a..aa4fb9b 100644 --- a/docs/guides.mdx +++ b/docs/guides.mdx @@ -18,6 +18,14 @@ These guides provide practical, hands-on instructions for implementing common in Step-by-step guide to add Suga infrastructure management to your existing applications. + + Connect the Suga documentation MCP server to your coding agents for real-time + documentation access. + + + +Claude Code supports MCP servers through a simple CLI command: + +```bash +claude mcp add --transport http suga-docs https://docs.addsuga.com/mcp +``` + +This adds the Suga documentation server to your Claude Code configuration. + +**Verify Installation** + +Check that the server was added successfully: + +```bash +claude mcp list +``` + +You should see `suga-docs` in the list of available MCP servers. + +**Usage** + +Once configured, Claude Code can automatically query Suga documentation when you ask questions about Suga features, CLI commands, or implementation patterns. + +Example queries: +- "How do I set up database migrations in Suga?" +- "What are the available Suga CLI commands for managing environments?" +- "Show me how to configure a custom platform in Suga" + +**Project-Specific Configuration** + +To share this configuration with your team, add it to your project's `.mcp.json` file: + +```json +{ + "mcpServers": { + "suga-docs": { + "url": "https://docs.addsuga.com/mcp" + } + } +} +``` + +Commit this file to your repository so all team members can access the Suga documentation MCP server. + +**Documentation**: [Claude Code MCP Guide](https://docs.claude.com/en/docs/claude-code/mcp) + + + + + +**Adding to Cursor** + +1. Open Cursor Settings (`Cmd/Ctrl + ,`) +2. Navigate to **Features** > **Model Context Protocol** +3. Click **Add MCP Server** +4. Configure the server: + +```json +{ + "mcpServers": { + "suga-docs": { + "url": "https://docs.addsuga.com/mcp" + } + } +} +``` + +5. Save and restart Cursor + +**Usage in Cursor** + +Once configured, you can reference Suga documentation in your Cursor conversations: + +- Use `Cmd+K` or `Ctrl+K` to open the composer +- Ask questions about Suga features and the AI will query the documentation +- The MCP server provides context automatically when relevant + +**Documentation**: [Cursor MCP Guide](https://docs.cursor.com/context/model-context-protocol) + + + + + + +**Adding to Windsurf** + +1. Open Windsurf Settings +2. Navigate to **MCP Servers** +3. Click **Add Server** +4. Enter the configuration: + +```json +{ + "mcpServers": { + "suga-docs": { + "serverUrl": "https://docs.addsuga.com/mcp" + } + } +} +``` + +5. Save and restart Windsurf + +**Usage in Windsurf** + +Windsurf's Cascade AI will automatically query the Suga documentation when you ask about Suga-related topics. + +**Documentation**: [Windsurf MCP Integration Guide](https://docs.windsurf.com/windsurf/cascade/mcp) + + + + + +## Learn More + +- [Model Context Protocol Documentation](https://modelcontextprotocol.io) +- [Suga CLI Reference](/cli) +- [Suga Quickstart Guide](/quickstart)