|
| 1 | +## Cortex MCP Overview |
| 2 | + |
| 3 | +>[!NOTE] |
| 4 | +>**Research Preview** |
| 5 | +> |
| 6 | +>Not seeing the results you expect? This is an early version of the Cortex MCP. Please send feedback and bug reports to Cortex Customer Engineering. |
| 7 | +
|
| 8 | +Cortex MCP is a Model Context Protocol server that provides access to the Cortex API. It uses relevant context from your workspace, ensuring awareness of your system's structure when answering your questions. |
| 9 | + |
| 10 | +You can query information in natural language, powering faster decisions and efficient processes. For example: |
| 11 | + |
| 12 | +- Who is the right person to handle an incident with backend-server? |
| 13 | +- Show me the services that belong to the platform engineering team |
| 14 | +- We're having an incident with backend-server, give me a summary of information to help handle the incident |
| 15 | + |
| 16 | +## Requirements |
| 17 | + |
| 18 | +Before getting started, you'll need: |
| 19 | + |
| 20 | +- **MCP Client**: Claude Desktop or other MCP-compatible client |
| 21 | +- **Cortex Personal Access Token**: [Create a token](https://docs.cortex.io/settings/api-keys/personal-tokens) in your Cortex workspace settings. |
| 22 | + |
| 23 | +## Installation |
| 24 | + |
| 25 | +Then configure your MCP client. We've tested this with Claude Desktop, and Cursor, but it should work with any MCP-compatible client.: |
| 26 | + |
| 27 | +### Claude Desktop |
| 28 | + |
| 29 | +```json |
| 30 | +{ |
| 31 | + "mcpServers": { |
| 32 | + "cortex": { |
| 33 | + "command": "docker", |
| 34 | + "args": [ |
| 35 | + "run", |
| 36 | + "--rm", |
| 37 | + "-i", |
| 38 | + "--env", |
| 39 | + "CORTEX_API_TOKEN=YOUR_API_TOKEN_HERE", |
| 40 | + "ghcr.io/cortexapps/cortex-mcp:latest" |
| 41 | + ] |
| 42 | + } |
| 43 | + } |
| 44 | +} |
| 45 | +``` |
| 46 | + |
| 47 | + |
| 48 | +### Cursor |
| 49 | + |
| 50 | +```json |
| 51 | +{ |
| 52 | + "mcpServers": { |
| 53 | + "cortex": { |
| 54 | + "command": "docker", |
| 55 | + "args": [ |
| 56 | + "run", |
| 57 | + "--rm", |
| 58 | + "-i", |
| 59 | + "--env", |
| 60 | + "CORTEX_API_TOKEN=YOUR_API_TOKEN_HERE", |
| 61 | + "ghcr.io/cortexapps/cortex-mcp:latest" |
| 62 | + ] |
| 63 | + } |
| 64 | + } |
| 65 | +} |
| 66 | + |
| 67 | +``` |
| 68 | + |
| 69 | +### VSCode |
| 70 | + |
| 71 | +[VS Code MCP Servers Documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) |
| 72 | + |
| 73 | +Sample `.vscode/mcp.json` |
| 74 | + |
| 75 | +```json |
| 76 | +{ |
| 77 | + "inputs": [ |
| 78 | + { |
| 79 | + "type": "promptString", |
| 80 | + "id": "cortex-key", |
| 81 | + "description": "Cortex API Key", |
| 82 | + "password": true |
| 83 | + } |
| 84 | + ], |
| 85 | + "servers": { |
| 86 | + "Cortex": { |
| 87 | + "type": "stdio", |
| 88 | + "command": "docker", |
| 89 | + "args": [ |
| 90 | + "run", |
| 91 | + "--rm", |
| 92 | + "-i", |
| 93 | + "ghcr.io/cortexapps/cortex-mcp:latest" |
| 94 | + ], |
| 95 | + "env": { |
| 96 | + "CORTEX_API_TOKEN": "${input:cortex-key}" |
| 97 | + } |
| 98 | + } |
| 99 | + } |
| 100 | +} |
| 101 | + |
| 102 | +``` |
| 103 | + |
| 104 | + |
| 105 | +## Support |
| 106 | + |
| 107 | +- GitHub Issues: https://github.com/cortexapps/cortex-mcp/issues |
| 108 | + |
| 109 | + |
| 110 | +## License |
| 111 | + |
| 112 | +MIT License - see [LICENSE](LICENSE) file for details. |
0 commit comments