From 92b3cc73e79bdf8cf9f311b615d0273ca856cbf0 Mon Sep 17 00:00:00 2001 From: Pedram Amini Date: Sun, 28 Dec 2025 12:55:44 -0600 Subject: [PATCH] added doc MCP server information --- CLAUDE.md | 23 +++++++++++++++++++++++ CONTRIBUTING.md | 23 +++++++++++++++++++++++ README.md | 1 + docs/docs.json | 7 +++++++ 4 files changed, 54 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index f878b4cd..6a786226 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -122,6 +122,7 @@ src/ | Modify file linking | `src/renderer/utils/remarkFileLinks.ts` (remark plugin for `[[wiki]]` and path links) | | Add documentation page | `docs/*.md`, `docs/docs.json` (navigation) | | Add documentation screenshot | `docs/screenshots/` (PNG, kebab-case naming) | +| MCP server integration | See [MCP Server docs](https://docs.runmaestro.ai/mcp-server) | ## Core Patterns @@ -677,3 +678,25 @@ firstAutoRunCompleted: boolean // Triggers celebration modal ### Modal Escape Not Working 1. Register with layer stack (don't handle Escape locally) 2. Check priority is set correctly + +## MCP Server + +Maestro provides a hosted MCP (Model Context Protocol) server for AI applications to search the documentation. + +**Server URL:** `https://docs.runmaestro.ai/mcp` + +**Available Tools:** +- `SearchMaestro` - Search the Maestro knowledge base for documentation, code examples, API references, and guides + +**Connect from Claude Desktop/Code:** +```json +{ + "mcpServers": { + "maestro": { + "url": "https://docs.runmaestro.ai/mcp" + } + } +} +``` + +See [MCP Server documentation](https://docs.runmaestro.ai/mcp-server) for full details. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 100678c5..fbccd45a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -925,6 +925,29 @@ mintlify dev This starts a local server at `http://localhost:3000` with hot reload. +### MCP Server + +Maestro provides a hosted MCP (Model Context Protocol) server that allows AI applications to search the documentation: + +**Server URL:** `https://docs.runmaestro.ai/mcp` + +**Available Tools:** +- `SearchMaestro` - Search the Maestro knowledge base for documentation, code examples, and guides + +To connect from Claude Desktop or Claude Code, add to your MCP configuration: + +```json +{ + "mcpServers": { + "maestro": { + "url": "https://docs.runmaestro.ai/mcp" + } + } +} +``` + +See [MCP Server documentation](https://docs.runmaestro.ai/mcp-server) for full details. + ### Deployment Documentation is automatically deployed when changes to `docs/` are pushed to `main`. Mintlify handles the build and hosting. diff --git a/README.md b/README.md index fb083d3f..352c173b 100644 --- a/README.md +++ b/README.md @@ -131,6 +131,7 @@ Full documentation and usage guide available at **[docs.runmaestro.ai](https://d - [Git Worktrees](https://docs.runmaestro.ai/git-worktrees) - [Keyboard Shortcuts](https://docs.runmaestro.ai/keyboard-shortcuts) - [Context Management](https://docs.runmaestro.ai/context-management) +- [MCP Server](https://docs.runmaestro.ai/mcp-server) - Connect AI apps to Maestro docs - [Troubleshooting](https://docs.runmaestro.ai/troubleshooting) ## Community diff --git a/docs/docs.json b/docs/docs.json index a7f4a78e..10752b66 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -75,6 +75,13 @@ "provider-nuances" ] }, + { + "group": "Integrations", + "pages": [ + "mcp-server" + ], + "icon": "plug" + }, { "group": "Reference", "pages": [