Skip to content

Commit deccc55

Browse files
authored
MCP server docs updated (#348)
* MCP server docs updated * MCP server installation guide update * mcp docs updated * merge main * text bold
1 parent a30d641 commit deccc55

File tree

1 file changed

+82
-27
lines changed

1 file changed

+82
-27
lines changed

integrations/mcp-server.mdx

Lines changed: 82 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,92 @@
11
---
2-
title: MCP server (Cursor)
3-
description: How to set up a Shuttle Docs MCP server for use in AI editors
2+
title: MCP server
3+
description: How to set up the Shuttle MCP server for use in AI coding assistants
44
icon: sparkles
55
---
66

7-
Take your coding of Shuttle apps to the next level with an [MCP](https://modelcontextprotocol.io/introduction) server! Imagine having Shuttle's entire knowledge base directly integrated with your AI coding tools. That's exactly what the MCP server delivers.
7+
To make Rust development even better, we've built the Shuttle MCP server.
88

9-
## What’s this for?
9+
The Shuttle [MCP server](https://modelcontextprotocol.io/) brings our entire documentation and tooling ecosystem directly into your favorite AI coding assistant. Think of it as having a Shuttle expert sitting right next to you while you code.
1010

11-
The MCP server is a lightweight local service that bridges your Shuttle apps with AI editors like Cursor. It feeds your editor contextual knowledge about Shuttle's source code and documentation, supercharging your development experience.
11+
## What's this for?
1212

13-
## Add to Cursor
13+
The Shuttle MCP server supercharges your development workflow in two powerful ways:
1414

15-
The Shuttle CLI (version 0.56 and later) packs a built-in MCP server with tools for searching docs and executing basic shuttle commands.
15+
**Contextual Knowledge**: It acts as a bridge between Shuttle's comprehensive documentation and your AI coding assistant, providing instant access to Shuttle-specific guidance without leaving your editor. No more tab-switching between docs and code!
1616

17-
To use the MCP server in [Cursor](https://www.cursor.com/) ([docs](https://docs.cursor.com/context/model-context-protocol)), adapt this to Cursor's config:
17+
**Powerful Development Tools**: Beyond just documentation, the MCP server gives your AI agent direct access to Shuttle's tooling ecosystem. Your assistant can help you deploy services, fetch logs, and interact with the Shuttle console - all through natural conversation. This makes Shuttle development significantly faster and more intuitive.
1818

19-
```json
19+
## Installation
20+
21+
The Shuttle MCP server comes with the **Shuttle CLI (version 0.56 and later)**, make sure you have the [Shuttle CLI](https://docs.shuttle.dev/getting-started/installation) installed first.
22+
23+
## Configuration
24+
25+
Choose your preferred AI coding environment and add the Shuttle MCP server configuration.
26+
27+
<CodeGroup>
28+
29+
```json Cursor
2030
{
2131
"mcpServers": {
22-
"shuttle": {
32+
"Shuttle": {
2333
"command": "shuttle",
2434
"args": ["mcp", "start"]
2535
}
2636
}
2737
}
2838
```
2939

30-
## You’re all set! ✅
40+
```json Windsurf
41+
{
42+
"mcpServers": {
43+
"Shuttle": {
44+
"command": "shuttle",
45+
"args": ["mcp", "start"]
46+
}
47+
}
48+
}
49+
```
3150

32-
You should now be able to ask the Cursor agent Shuttle-related questions and get more detailed, informative answers—powered by your local Shuttle Docs MCP server.
33-
The Composer Agent will automatically use any MCP tools listed under Available Tools when relevant.
34-
To trigger Shuttle Docs MCP server tool intentionally, just tell the agent by referring to its name or description.
35-
We are working to make this even more powerful and would love to get your thoughts.
51+
```json VSCode
52+
{
53+
"servers": {
54+
"Shuttle": {
55+
"type": "stdio",
56+
"command": "shuttle",
57+
"args": ["mcp", "start"]
58+
}
59+
}
60+
}
61+
```
62+
63+
```json Claude Desktop
64+
{
65+
"mcpServers": {
66+
"Shuttle": {
67+
"command": "shuttle",
68+
"args": ["mcp", "start"]
69+
}
70+
}
71+
}
72+
```
73+
74+
</CodeGroup>
75+
76+
### Configuration File Locations
77+
78+
| IDE | Configuration Path |
79+
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
80+
| Cursor | `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project) |
81+
| Windsurf | `~/.codeium/windsurf/mcp_config.json` |
82+
| VSCode | User settings or `.vscode/mcp.json` (project) |
83+
| Claude Desktop | **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`<br/>**Windows**: `%APPDATA%\Claude\claude_desktop_config.json` |
84+
85+
## You're all set! 🚀
86+
87+
Your AI coding assistant now has direct access to Shuttle's knowledge base and tooling. Whether you're deploying services, managing resources, or troubleshooting issues, your AI companion can provide contextual, accurate guidance powered by the official Shuttle documentation.
88+
89+
The integration works seamlessly in the background - just code naturally and let your AI assistant tap into Shuttle's expertise when needed. Happy coding!
3690

3791
## Other MCPs
3892

@@ -41,20 +95,21 @@ We are working to make this even more powerful and would love to get your though
4195
>
4296
You can also get an MCP that only queries the Shuttle Docs via [Mintlify](https://mintlify.com/):
4397

44-
```sh
45-
npx mint-mcp add shuttle
46-
```
98+
```sh
99+
npx mint-mcp add shuttle
100+
```
47101

48-
And add this to the config
102+
And add this to the config
49103

50-
```json
51-
{
52-
"mcpServers": {
53-
"shuttle-docs": {
54-
"command": "node",
55-
"args": ["/home/user/.mcp/shuttle/src/index.js"]
56-
}
104+
```json
105+
{
106+
"mcpServers": {
107+
"shuttle-docs": {
108+
"command": "node",
109+
"args": ["/home/user/.mcp/shuttle/src/index.js"]
57110
}
58111
}
59-
```
112+
}
113+
```
114+
60115
</Accordion>

0 commit comments

Comments
 (0)