Skip to content

docs: add Connect AI Tools setup with MCP - #84

Open
AllenAJ wants to merge 1 commit into
RequestNetwork:mainfrom
AllenAJ:docs/connect-ai-tools
Open

docs: add Connect AI Tools setup with MCP#84
AllenAJ wants to merge 1 commit into
RequestNetwork:mainfrom
AllenAJ:docs/connect-ai-tools

Conversation

@AllenAJ

Copy link
Copy Markdown

Summary

  • Add new page: api-setup/connect-ai-tools
  • Document MCP setup for Claude Code and Cursor
  • Add Request Network MCP endpoint and llms.txt / llms-full.txt links
  • Add navigation entry under API Setup in docs.json

Why

Developers increasingly use AI coding tools. This page makes docs grounding setup explicit and copy-paste ready.

Test plan

  • Previewed page in Mintlify dev
  • Verified navigation entry appears under API Setup
  • Verified links and commands render correctly

Made with Cursor

Add a dedicated API setup page for connecting Claude Code and Cursor via MCP,
including Request Network Mintlify MCP and llms endpoints, then wire it into nav.
Made-with: Cursor
@greptile-apps

Copy link
Copy Markdown

Greptile Summary

This PR adds a new api-setup/connect-ai-tools documentation page and a corresponding docs.json navigation entry, giving developers copy-paste-ready instructions for connecting Claude Code or Cursor to Request Network docs via MCP, as well as llms.txt / llms-full.txt links for script-based pipelines.

Key points:

  • The MCP server URL, CLI command, and Cursor configuration fields are all accurate and self-consistent.
  • The docs.json placement (after getting-started, before the portal/API key management page) is logical.
  • Three style-guide violations from AGENTS.md are present in the new .mdx file: the Claude Code and Cursor sections should be wrapped in a <Tabs> component (the guide explicitly requires Tabs for platform alternatives), the "Verify the connection" step is missing a <Check> callout, and there is no troubleshooting section despite the guide requiring one for likely failure points.
  • No broken links, no secrets, and no functional regressions.

Confidence Score: 4/5

  • Safe to merge with minor style-guide fixes remaining.
  • The changes are purely additive documentation with no functional code. The MCP URL, CLI command syntax, and nav entry are all correct. The three P2 comments are all style-guide alignment issues (Tabs, Check callout, troubleshooting section) that improve the page but don't block it from being useful and accurate as-is.
  • api-setup/connect-ai-tools.mdx — three AGENTS.md style violations worth addressing before or after merge.

Important Files Changed

FilenameOverview
api-setup/connect-ai-tools.mdxNew page documenting MCP setup for Claude Code and Cursor; content is accurate and well-structured, but violates AGENTS.md guidelines by using separate H2 sections instead of <Tabs> for platform alternatives, omitting <Check> callouts in verification steps, and missing a troubleshooting section.
docs.jsonAdds api-setup/connect-ai-tools to the navigation under the "🔑 API Setup" group — minimal, correct change with valid JSON and sensible placement after getting-started.

Sequence Diagram

sequenceDiagram
participant Dev as Developer / AI Tool
participant CLI as Claude Code CLI
participant Cursor as Cursor IDE
participant MCP as requestnetwork.mintlify.app/mcp
participant Docs as Request Network Docs
Note over Dev,Docs: Claude Code setup
Dev->>CLI: claude mcp add --transport http request-network-docs <url>
CLI-->>Dev: Server registered
Dev->>CLI: claude mcp list
CLI-->>Dev: request-network-docs ✓
Note over Dev,Docs: Cursor setup
Dev->>Cursor: Add MCP server (name, transport HTTP, URL)
Cursor-->>Dev: Server saved
Note over Dev,Docs: Runtime doc query
Dev->>CLI: Ask docs-grounded question
CLI->>MCP: Query docs via MCP protocol
MCP->>Docs: Fetch latest content
Docs-->>MCP: Documentation response
MCP-->>CLI: Structured answer
CLI-->>Dev: Response grounded in live docs
Note over Dev,Docs: Script / pipeline (no MCP client)
Dev->>Docs: GET /llms.txt or /llms-full.txt
Docs-->>Dev: Sitemap index or full Markdown
Loading

Reviews (1): Last reviewed commit: "docs: add Connect AI Tools setup page" | Re-trigger Greptile

Comment threadapi-setup/connect-ai-tools.mdx
Comment threadapi-setup/connect-ai-tools.mdx
Comment threadapi-setup/connect-ai-tools.mdx
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@AllenAJ@rodrigopavezi