serverpod_mcp

This MCP server provides Serverpod documentation and guides as MCP resources and offers a natural language Q&A capability for Serverpod. It fetches Serverpod guides and docs from Serverpod's Starguide backend, exposing them as searchable resources that you can browse or query directly from your editor. You can also ask questions about Serverpod, and the server will generate responses based on the documentation and related discussions using Gemini.

To use it, first ensure you have a Gemini API key available (or set it through the SERVERPOD_MCP_GEMINI_API_KEY environment variable). In your MCP configuration, add the serverpod_mcp instance with the appropriate gemini API key. Once configured, you can access Serverpod docs and guides as MCP resources, search across them, and use the natural language Q&A tool to get concise explanations or guidance drawn from the docs.

Prerequisites:

• Dart SDK (recommended: ^3.8.1 or newer)
• Gemini API key (required for ask-docs feature)

Install steps:

1. Install the MCP server globally using Dart: dart pub global activate serverpod_mcp

2. (Optional) Set the Gemini API key via environment variable:

   • On Unix-like systems: export SERVERPOD_MCP_GEMINI_API_KEY=your_api_key_here
   • On Windows (PowerShell): $env:SERVERPOD_MCP_GEMINI_API_KEY = "your_api_key_here"

3. Add the MCP server to your editor configuration (example using Cursor config): { "mcpServers": { "dart": { "command": "dart", "args": [ "mcp-server" ] }, "serverpod": { "command": "serverpod_mcp", "args": [ "--gemini-api-key", "YOUR_GEMINI_API_KEY" ], "rootDetection": { "strategy": "workspace" } } } }

4. Replace YOUR_GEMINI_API_KEY with your actual Gemini API key or rely on the environment variable.

5. Open your editor and load the MCP configuration; you should be able to browse Serverpod docs, guides, and use the Q&A features.

Notes and tips:

• The server requires a Gemini API key for the ask-docs functionality. If you don’t need Q&A, you can omit the key by leaving it out of the command, but the feature won’t be available.
• If you prefer not to hard-code the key, set the SERVERPOD_MCP_GEMINI_API_KEY environment variable and omit the --gemini-api-key argument in the config.
• Root detection is set to workspace, which helps determine the project root for proper context when loading resources.
• Ensure your Editor’s MCP integration can reach the serverpod_mcp executable from your environment path or configured path. If you relocate the binary, update the command path accordingly.
• This MCP server pulls docs and guides from Serverpod’s Starguide backend; uptime depends on the backend availability. Consider caching strategies in your editor if supported.