@synapsestudios/synapse-docs-mcp-server
v1.1.0
Published
MCP server for Synapse Studios documentation
Readme
Synapse Docs MCP Server
An MCP (Model Context Protocol) server that provides access to Synapse Studios documentation at https://docs.synapsestudios.com/
Features
This MCP server exposes two tools:
list_docs - List all available documentation pages with summaries and document IDs
- No parameters required
- Returns a categorized list of all documentation with 2-sentence summaries
- Each document includes a unique ID for use with
fetch_doc - IMPORTANT: Always use this tool first to get the correct document ID
fetch_doc - Fetch full content from a specific documentation page
- Parameters:
doc_id(string) - Example:
fetch_doc(doc_id="clean-architecture") - IMPORTANT: You must retrieve the document ID from
list_docsfirst - do not guess or construct IDs
- Parameters:
Installation
For Claude Code
Add this configuration to your project's .mcp.json file at the project root:
{
"mcpServers": {
"synapse-docs": {
"command": "npx",
"args": ["-y", "@synapsestudios/synapse-docs-mcp-server@latest"]
}
}
}This will automatically download and run the latest version of the MCP server using npx.
Auto-Approve Tool Usage (Optional)
To avoid approval prompts for this MCP server's tools, add this to your .claude/settings.json:
{
"permissions": {
"allow": [
"mcp__synapse-docs__fetch_doc",
"mcp__synapse-docs__list_docs"
]
}
}You can configure this at different scopes:
- Project-wide (shared with team):
.claude/settings.json - Local only (not in git):
.claude/settings.local.json - User-wide (all projects):
~/.claude/settings.json
For Claude Desktop
Add this to your Claude Desktop config file:
MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"synapse-docs": {
"command": "npx",
"args": ["-y", "@synapsestudios/synapse-docs-mcp-server@latest"]
}
}
}Usage Workflow
First, use
list_docsto browse available documentation and get document IDs:list_docs()Find the document you need in the categorized list with summaries
Use the document ID (shown as "ID: document-id") with
fetch_doc:fetch_doc(doc_id="clean-architecture")
Available Documentation
The server provides access to 21 Synapse Studios internal documentation articles across 6 categories:
- Concepts - Architecture (4 articles): coupling-and-cohesion, clean-architecture, modular-monolith, dependency-inversion
- Concepts - Patterns (3 articles): use-cases, repository, page-object
- Concepts - Testing (5 articles): unit-testing, test-driven-development, backend-integration-testing, frontend-testing, acceptance-testing
- Implementation - Frameworks (4 articles): nest-design-guidelines, react-design-guidelines, nextjs-best-practices, vite-best-practices
- Implementation - Testing (3 articles): acceptance-testing-guidelines, nest-api-testing-guidelines, react-testing-guidelines
- Implementation - CI/CD (2 articles): build-pipeline-standards, pull-request-standards
Use list_docs to see full titles and 2-sentence summaries for each article.
