serverpod_mcp 0.1.1
serverpod_mcp: ^0.1.1 copied to clipboard
A Serverpod MCP (Model Context Protocol) server that provides access to Serverpod documentation and guides.
Example: Using Serverpod MCP #
This example shows how to install, configure, and try the Serverpod MCP server in an MCP-compatible client.
Prerequisites #
- Dart SDK: ^3.8.1
- Gemini API key (optional; required for
ask-docs)
Install #
dart pub global activate serverpod_mcp
Configure in Cursor #
Add this to your settings.json:
{
"mcpServers": {
"serverpod": {
"command": "serverpod_mcp",
"args": ["--gemini-api-key", "YOUR_GEMINI_API_KEY"],
"rootDetection": { "strategy": "workspace" }
}
}
}
Alternatively, set an environment variable (no --gemini-api-key arg needed):
export SERVERPOD_MCP_GEMINI_API_KEY=YOUR_GEMINI_API_KEY
Try it #
- List guides: Ask your client to run
list-guidesto see available URIs and descriptions. - Open a guide: Use
get-guidewith a URI from the list to read the guide. - Ask a question: Ask something like “How do I create a new endpoint in Serverpod?” (uses
ask-docs; requires API key).
For more details, see the main README.