Skip to content
This repository was archived by the owner on Mar 17, 2026. It is now read-only.

Commit 098f0eb

Browse files
tjholmtjholm
authored
docs: add mcp integration guide for suga docs mcp server (#129)
1 parent ca3f133 commit 098f0eb

4 files changed

Lines changed: 155 additions & 0 deletions

File tree

‎docs/.vale/styles/config/vocabularies/Suga/accept.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ resource_group_name
3232
storage_account_name
3333
container_name
3434
tfstatestorage
35+
mcpServers
3536

3637
# Defaults from mintlify
3738
Mintlify

‎docs/docs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"pages": [
3131
"guides",
3232
"guides/add-suga",
33+
"guides/mcp-integration",
3334
"guides/build-platform",
3435
"guides/database-migration",
3536
"guides/terraform-backend-config",

‎docs/guides.mdx‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ These guides provide practical, hands-on instructions for implementing common in
1818
Step-by-step guide to add Suga infrastructure management to your existing
1919
applications.
2020
</Card>
21+
<Card
22+
title="Add Suga Docs to Your AI Agent"
23+
icon="robot"
24+
href="/guides/mcp-integration"
25+
>
26+
Connect the Suga documentation MCP server to your coding agents for real-time
27+
documentation access.
28+
</Card>
2129
<Card
2230
title="Database Migrations"
2331
icon="database"

‎docs/guides/mcp-integration.mdx‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
---
2+
title: 'Add Suga Docs to Your AI Agent'
3+
description: 'Connect the Suga documentation MCP server to your coding agents for real-time documentation access'
4+
---
5+
6+
## Overview
7+
8+
Suga's documentation is available through a [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server, enabling AI coding agents to query our documentation in real-time. This integration allows your AI tools to provide accurate, up-to-date information about Suga without manually copying documentation into context windows.
9+
10+
## MCP Server URL
11+
12+
The Suga documentation MCP server is hosted at:
13+
14+
```
15+
https://docs.addsuga.com/mcp
16+
```
17+
18+
This server provides:
19+
- **Documentation Search**: Query all Suga documentation, guides, and CLI references
20+
- **Real-time Access**: Always get the latest documentation without manual updates
21+
22+
## Integration Guides
23+
24+
Follow the instructions below for your preferred coding agent:
25+
26+
<Tabs>
27+
<Tab title="Claude Code">
28+
29+
Claude Code supports MCP servers through a simple CLI command:
30+
31+
```bash
32+
claude mcp add --transport http suga-docs https://docs.addsuga.com/mcp
33+
```
34+
35+
This adds the Suga documentation server to your Claude Code configuration.
36+
37+
**Verify Installation**
38+
39+
Check that the server was added successfully:
40+
41+
```bash
42+
claude mcp list
43+
```
44+
45+
You should see `suga-docs` in the list of available MCP servers.
46+
47+
**Usage**
48+
49+
Once configured, Claude Code can automatically query Suga documentation when you ask questions about Suga features, CLI commands, or implementation patterns.
50+
51+
Example queries:
52+
- "How do I set up database migrations in Suga?"
53+
- "What are the available Suga CLI commands for managing environments?"
54+
- "Show me how to configure a custom platform in Suga"
55+
56+
**Project-Specific Configuration**
57+
58+
To share this configuration with your team, add it to your project's `.mcp.json` file:
59+
60+
```json
61+
{
62+
"mcpServers": {
63+
"suga-docs": {
64+
"url": "https://docs.addsuga.com/mcp"
65+
}
66+
}
67+
}
68+
```
69+
70+
Commit this file to your repository so all team members can access the Suga documentation MCP server.
71+
72+
**Documentation**: [Claude Code MCP Guide](https://docs.claude.com/en/docs/claude-code/mcp)
73+
74+
</Tab>
75+
76+
<Tab title="Cursor">
77+
78+
**Adding to Cursor**
79+
80+
1. Open Cursor Settings (`Cmd/Ctrl + ,`)
81+
2. Navigate to **Features** > **Model Context Protocol**
82+
3. Click **Add MCP Server**
83+
4. Configure the server:
84+
85+
```json
86+
{
87+
"mcpServers": {
88+
"suga-docs": {
89+
"url": "https://docs.addsuga.com/mcp"
90+
}
91+
}
92+
}
93+
```
94+
95+
5. Save and restart Cursor
96+
97+
**Usage in Cursor**
98+
99+
Once configured, you can reference Suga documentation in your Cursor conversations:
100+
101+
- Use `Cmd+K` or `Ctrl+K` to open the composer
102+
- Ask questions about Suga features and the AI will query the documentation
103+
- The MCP server provides context automatically when relevant
104+
105+
**Documentation**: [Cursor MCP Guide](https://docs.cursor.com/context/model-context-protocol)
106+
107+
</Tab>
108+
109+
110+
<Tab title="Windsurf">
111+
112+
**Adding to Windsurf**
113+
114+
1. Open Windsurf Settings
115+
2. Navigate to **MCP Servers**
116+
3. Click **Add Server**
117+
4. Enter the configuration:
118+
119+
```json
120+
{
121+
"mcpServers": {
122+
"suga-docs": {
123+
"serverUrl": "https://docs.addsuga.com/mcp"
124+
}
125+
}
126+
}
127+
```
128+
129+
5. Save and restart Windsurf
130+
131+
**Usage in Windsurf**
132+
133+
Windsurf's Cascade AI will automatically query the Suga documentation when you ask about Suga-related topics.
134+
135+
**Documentation**: [Windsurf MCP Integration Guide](https://docs.windsurf.com/windsurf/cascade/mcp)
136+
137+
</Tab>
138+
139+
</Tabs>
140+
141+
## Learn More
142+
143+
- [Model Context Protocol Documentation](https://modelcontextprotocol.io)
144+
- [Suga CLI Reference](/cli)
145+
- [Suga Quickstart Guide](/quickstart)

0 commit comments

Comments
 (0)