added doc MCP server information

This commit is contained in:
Pedram Amini
2025-12-28 12:55:44 -06:00
parent 616d7c8ed2
commit 92b3cc73e7
4 changed files with 54 additions and 0 deletions

View File

@@ -122,6 +122,7 @@ src/
| Modify file linking | `src/renderer/utils/remarkFileLinks.ts` (remark plugin for `[[wiki]]` and path links) | | 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 page | `docs/*.md`, `docs/docs.json` (navigation) |
| Add documentation screenshot | `docs/screenshots/` (PNG, kebab-case naming) | | Add documentation screenshot | `docs/screenshots/` (PNG, kebab-case naming) |
| MCP server integration | See [MCP Server docs](https://docs.runmaestro.ai/mcp-server) |
## Core Patterns ## Core Patterns
@@ -677,3 +678,25 @@ firstAutoRunCompleted: boolean // Triggers celebration modal
### Modal Escape Not Working ### Modal Escape Not Working
1. Register with layer stack (don't handle Escape locally) 1. Register with layer stack (don't handle Escape locally)
2. Check priority is set correctly 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.

View File

@@ -925,6 +925,29 @@ mintlify dev
This starts a local server at `http://localhost:3000` with hot reload. 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 ### Deployment
Documentation is automatically deployed when changes to `docs/` are pushed to `main`. Mintlify handles the build and hosting. Documentation is automatically deployed when changes to `docs/` are pushed to `main`. Mintlify handles the build and hosting.

View File

@@ -131,6 +131,7 @@ Full documentation and usage guide available at **[docs.runmaestro.ai](https://d
- [Git Worktrees](https://docs.runmaestro.ai/git-worktrees) - [Git Worktrees](https://docs.runmaestro.ai/git-worktrees)
- [Keyboard Shortcuts](https://docs.runmaestro.ai/keyboard-shortcuts) - [Keyboard Shortcuts](https://docs.runmaestro.ai/keyboard-shortcuts)
- [Context Management](https://docs.runmaestro.ai/context-management) - [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) - [Troubleshooting](https://docs.runmaestro.ai/troubleshooting)
## Community ## Community

View File

@@ -75,6 +75,13 @@
"provider-nuances" "provider-nuances"
] ]
}, },
{
"group": "Integrations",
"pages": [
"mcp-server"
],
"icon": "plug"
},
{ {
"group": "Reference", "group": "Reference",
"pages": [ "pages": [