mirror of
https://github.com/jlengrand/Maestro.git
synced 2026-03-10 08:31:19 +00:00
3b5c0b5bfe
- Added mention that MCP server is hosted by Mintlify - Added proactive search behavior explanation - Added Cursor and VS Code configuration instructions - Clarified transport type as HTTP/HTTPS (Streamable HTTP) - Added note about page indexing limitations - Verified all existing information is accurate
123 lines
3.0 KiB
Markdown
123 lines
3.0 KiB
Markdown
---
|
|
title: MCP Server
|
|
description: Connect AI applications to Maestro's documentation knowledge base using the Model Context Protocol.
|
|
icon: plug
|
|
---
|
|
|
|
# MCP Server
|
|
|
|
Maestro provides a hosted MCP (Model Context Protocol) server that allows AI applications to search and retrieve information from the Maestro documentation. The server is automatically generated and hosted by [Mintlify](https://mintlify.com).
|
|
|
|
## Overview
|
|
|
|
The MCP server exposes a `SearchMaestro` tool that enables AI assistants to find relevant documentation, code examples, API references, and guides from the Maestro knowledge base. When connected, your AI assistant can proactively search the documentation while generating responses—not just when explicitly asked.
|
|
|
|
**MCP Server URL:**
|
|
```
|
|
https://docs.runmaestro.ai/mcp
|
|
```
|
|
|
|
## Available Tools
|
|
|
|
### SearchMaestro
|
|
|
|
Search across the Maestro knowledge base to find relevant information.
|
|
|
|
**Use this tool when you need to:**
|
|
- Answer questions about Maestro features and functionality
|
|
- Find specific documentation pages
|
|
- Understand how features work
|
|
- Locate implementation details and code examples
|
|
|
|
**Returns:**
|
|
- Contextual content with titles
|
|
- Direct links to documentation pages
|
|
|
|
## Connecting AI Applications
|
|
|
|
### Claude Desktop
|
|
|
|
Add the MCP server to your Claude Desktop configuration (`claude_desktop_config.json`):
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"maestro": {
|
|
"url": "https://docs.runmaestro.ai/mcp"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Claude Code
|
|
|
|
Add to your Claude Code MCP settings:
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"maestro": {
|
|
"url": "https://docs.runmaestro.ai/mcp"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Cursor
|
|
|
|
In Cursor settings, go to **Features > MCP Servers** and add:
|
|
|
|
```
|
|
https://docs.runmaestro.ai/mcp
|
|
```
|
|
|
|
### VS Code
|
|
|
|
For VS Code with MCP support, add to your MCP configuration:
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"maestro": {
|
|
"url": "https://docs.runmaestro.ai/mcp"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Other MCP-Compatible Applications
|
|
|
|
Any application that supports the Model Context Protocol can connect using the server URL:
|
|
|
|
```
|
|
https://docs.runmaestro.ai/mcp
|
|
```
|
|
|
|
## Example Queries
|
|
|
|
Once connected, your AI assistant can use the `SearchMaestro` tool to answer questions like:
|
|
|
|
- "How do I set up Auto Run in Maestro?"
|
|
- "What keyboard shortcuts are available?"
|
|
- "How does Group Chat work?"
|
|
- "How do I configure git worktrees?"
|
|
- "What AI agents does Maestro support?"
|
|
|
|
## Technical Details
|
|
|
|
- **Protocol**: Model Context Protocol (MCP)
|
|
- **Transport**: HTTP/HTTPS (Streamable HTTP)
|
|
- **Authentication**: None required (public read-only access)
|
|
- **Rate Limits**: Standard API rate limits apply
|
|
- **Hosting**: Automatically managed by Mintlify
|
|
|
|
<Note>
|
|
The MCP server only indexes pages included in the documentation navigation. Hidden or excluded pages are not searchable.
|
|
</Note>
|
|
|
|
## Related Resources
|
|
|
|
- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
|
|
- [Maestro Documentation](https://docs.runmaestro.ai)
|
|
- [GitHub Repository](https://github.com/pedramamini/Maestro)
|