Skip to content

Commit aa18f65

Browse files
areibmancursoragentalex
authored
Cursor/create mcp docs section in documentation 3eb8 (#1143)
* Add MCP Docs guide and update introduction with MCP Docs Server info Co-authored-by: alex <alex@agentops.ai> * better banner * rearrange --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: alex <alex@agentops.ai>
1 parent 96eeb62 commit aa18f65

4 files changed

Lines changed: 70 additions & 2 deletions

File tree

docs/mint.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
},
105105
{
106106
"group": "Getting Started",
107-
"pages": ["v2/quickstart", "v2/examples/examples"],
107+
"pages": ["v2/quickstart", "v2/examples/examples", "v2/usage/mcp-docs", "v2/usage/mcp-server"],
108108
"version": "v2"
109109
},
110110
{
@@ -148,7 +148,6 @@
148148
"v2/usage/dashboard-info",
149149
"v2/usage/sdk-reference",
150150
"v2/usage/typescript-sdk",
151-
"v2/usage/mcp-server",
152151
"v2/usage/advanced-configuration",
153152
"v2/usage/context-managers",
154153
"v2/usage/tracking-llm-calls",

docs/v2/introduction.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ description: "AgentOps is the developer favorite platform for testing, debugging
1111
allowFullScreen
1212
></iframe>
1313

14+
<Note title="Chat with the docs in your IDE">
15+
Prefer asking your IDE? Install the Mintlify <a href="/v2/usage/mcp-docs"><strong>MCP Docs Server</strong></a> for AgentOps to chat with the docs while you code:
16+
`npx mint-mcp add agentops`
17+
</Note>
18+
1419

1520
## Integrate with developer favorite LLM providers and agent frameworks
1621

docs/v2/quickstart.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ AgentOps is designed for easy integration into your AI agent projects, providing
77

88
<Check>[Give us a star on GitHub!](https://github.com/AgentOps-AI/agentops) Your support helps us grow. ⭐</Check>
99

10+
<Note title="Chat with the docs in your IDE">
11+
Prefer asking your IDE? Install the Mintlify <a href="/v2/usage/mcp-docs"><strong>MCP Docs Server</strong></a> for AgentOps to chat with the docs while you code:
12+
`npx mint-mcp add agentops`
13+
</Note>
14+
1015
## Installation
1116
First, install the AgentOps SDK. We recommend including `python-dotenv` for easy API key management.
1217
<CodeGroup>

docs/v2/usage/mcp-docs.mdx

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: "MCP Docs"
3+
description: "Chat with the AgentOps documentation directly from your IDE using the Mintlify MCP Docs Server."
4+
---
5+
6+
7+
<Note>
8+
Looking for the AgentOps API tools instead? See the <a href="/v2/usage/mcp-server">MCP Server</a> guide.
9+
</Note>
10+
11+
# MCP Docs Server
12+
13+
The **Mintlify MCP Docs Server** gives you and your coding agents instant, programmatic access to every page in the AgentOps docs. It works in **Cursor**, **Windsurf**, **VS Code**, **Zed**, **Claude Code**, or any other tool that speaks the [Model Context Protocol](https://modelcontextprotocol.io/).
14+
15+
## Installation
16+
17+
```bash
18+
npx mint-mcp add agentops
19+
```
20+
21+
Run the command above in any folder and your IDE will automatically register the docs server. No extra configuration required.
22+
23+
## How it works
24+
25+
When you (or your in-editor AI assistant) ask a question, the IDE sends a request to the MCP Docs Server. The server searches the AgentOps docs and returns the most relevant sections so the assistant can craft a precise answer.
26+
27+
> **Example prompt**
28+
> "How do I record custom spans with the `@operation` decorator?"
29+
30+
## What you can ask
31+
32+
Here are a few ideas to get you started:
33+
34+
### Add features
35+
- "Add a chat interface with streaming support to my app"
36+
- "Instrument my agent with the `@trace` decorator"
37+
38+
### Ask about integrations
39+
- "How do I integrate AgentOps with the Vercel AI SDK?"
40+
- "Show me a working example for CrewAI"
41+
42+
### Debug or update existing code
43+
- "My trace isn't showing spans—what could be wrong?"
44+
- "How do I customize the styling of the Session Waterfall?"
45+
46+
If the answer lives in the docs, the server will find it.
47+
48+
## Common issues
49+
50+
### Server not starting
51+
1. Ensure `npx` is installed and working.
52+
2. Check for other MCP servers running on the same port.
53+
3. Verify your configuration file syntax.
54+
4. On Windows, confirm Node.js and npm are installed.
55+
56+
### Tool calls failing
57+
1. Restart the MCP Docs Server and/or your IDE.
58+
2. Update to the latest version of your IDE.
59+
3. Confirm that the AgentOps docs server appears in your IDE’s list of MCP servers.

0 commit comments

Comments
 (0)