Skip to content

Commit bc4d831

Browse files
committed
Enhance documentation for MCP-compatible generators by adding detailed descriptions, features, and usage scenarios. Update sections on GitHub-powered servers and improve formatting with icons for better clarity and organization.
1 parent 20ec990 commit bc4d831

File tree

3 files changed

+133
-49
lines changed

3 files changed

+133
-49
lines changed

doc-generators/custom-doc-generators.mdx

Lines changed: 57 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,36 @@ Key benefits include:
6565
GitMCP, mentioned in the GitHub-powered documentation servers category, is actually built on top of Cloudflare AutoRAG. This demonstrates how these managed RAG solutions can be used to create production-ready MCP documentation servers with relatively little effort.
6666
</Info>
6767

68+
<Info>
69+
<Icon icon="lightbulb" iconType="solid" /> **How AutoRAG Works**
70+
71+
AutoRAG handles two core processes:
72+
73+
1. **Indexing (Asynchronous Background Process)**:
74+
- **Data Ingestion**: Reads from your connected data sources
75+
- **Markdown Conversion**: Converts various file types into structured Markdown
76+
- **Chunking**: Splits content into smaller pieces for better retrieval
77+
- **Embedding**: Transforms chunks into vectors using Workers AI models
78+
- **Vector Storage**: Stores vectors and metadata in Vectorize database
79+
80+
2. **Querying (Real-time Synchronous Process)**:
81+
- **Query Rewriting**: Optionally improves search queries using LLMs
82+
- **Query Embedding**: Transforms queries into vectors for comparison
83+
- **Vector Matching**: Finds the most relevant content chunks
84+
- **Response Generation**: Uses retrieved context to generate accurate answers
85+
</Info>
86+
87+
<Check>
88+
<Icon icon="check-double" iconType="solid" /> **Key Advantages of RAG with AutoRAG**
89+
90+
- **Accuracy Without Training**: Get accurate answers based on your latest documentation without model training
91+
- **Reduced Hallucinations**: Ground AI responses in your actual documentation
92+
- **Source Attribution**: Trace responses back to specific documentation sources
93+
- **Knowledge Updates**: Documentation updates are automatically reflected in responses
94+
- **Efficient Context Usage**: Only relevant information is retrieved, maximizing context window usage
95+
- **Image Processing**: Can extract text and context from images in your documentation
96+
</Check>
97+
6898
<CardGroup cols={2}>
6999
<Card title="Automated Indexing" icon="robot" iconType="solid">
70100
Set up your data sources once and AutoRAG will continuously monitor and index new content, keeping your documentation current.
@@ -78,16 +108,38 @@ Key benefits include:
78108

79109
To create your own MCP documentation server using AutoRAG:
80110

81-
1. **Configure Data Sources**: Connect your documentation repositories, websites, or content stores
82-
2. **Set Up Indexing**: Configure chunking, embedding, and indexing settings
83-
3. **Define Retrieval Parameters**: Customize relevance thresholds and context window parameters
84-
4. **Implement MCP Protocol**: Wrap the AutoRAG responses in the MCP protocol format
85-
5. **Deploy and Monitor**: Launch your server and monitor performance
111+
<Steps>
112+
<Step title="Configure Data Sources">
113+
Connect your documentation repositories, websites, or content stores. AutoRAG supports various sources including websites, GitHub repositories, and file storage systems.
114+
</Step>
115+
116+
<Step title="Set Up Indexing">
117+
Configure chunking, embedding, and indexing settings. Determine how your content will be processed, including chunk size and overlap for optimal retrieval.
118+
</Step>
119+
120+
<Step title="Define Retrieval Parameters">
121+
Customize relevance thresholds and context window parameters. Set the number of chunks to retrieve and minimum similarity scores to ensure accurate results.
122+
</Step>
123+
124+
<Step title="Implement MCP Protocol">
125+
Wrap the AutoRAG responses in the MCP protocol format. Create endpoints that follow the MCP specification to enable seamless integration with AI assistants.
126+
</Step>
127+
128+
<Step title="Deploy and Monitor">
129+
Launch your server and monitor performance. Track key metrics like query latency, relevance scores, and user satisfaction to continuously improve your documentation system.
130+
</Step>
131+
</Steps>
86132

87133
<Tip>
88134
Start with a small subset of your documentation to test the system before scaling to your entire knowledge base.
89135
</Tip>
90136

137+
<Info>
138+
<Icon icon="book" iconType="solid" /> **Further Resources**
139+
140+
For complete implementation details, configuration options, and API references, be sure to follow the official [Cloudflare AutoRAG documentation](https://developers.cloudflare.com/autorag/). The documentation provides in-depth guides on data sources, indexing settings, query rewriting, similarity caching, and other advanced features.
141+
</Info>
142+
91143
## <Icon icon="circle-check" iconType="solid" color="#10B981" /> When to Choose Custom Solutions
92144

93145
Custom documentation generators are most valuable when:

doc-generators/github-powered-servers.mdx

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,21 @@ icon: "github"
55
iconType: "brands"
66
---
77

8-
Sometimes you don't *write* the docs yourself – you simply want the full, up‑to‑date documentation of an **open‑source library on GitHub** available to your AI assistant. The community projects below turn *any* repository into a remote MCP server that streams documentation on demand.
8+
Sometimes you don't *write* the docs yourself – you simply want the full, up‑to‑date documentation of an **open‑source library on GitHub** available to your AI assistant. The community projects below turn **_any_ repository into a remote MCP server** that streams documentation on demand.
99

1010
<Callout type="warning">
1111
<Icon icon="clock" iconType="solid" /> **First-Time Processing** – If a repository hasn't been previously indexed by Context7 or GitMCP, it may take some time (typically a few minutes) for the initial processing to complete as the system performs autoindexing and RAG preparation of the content.
1212
</Callout>
1313

14-
## Available Tools
14+
## <Icon icon="toolbox" iconType="solid" /> Available Tools
1515

1616
### <Icon icon="rocket" iconType="solid" /> Context7
1717

18-
Context7 automatically ingests popular open‑source libraries (and many private ones too) and exposes them as remote MCP servers.
18+
**Context7** automatically ingests **popular open‑source libraries** (and many **private ones** too) and exposes them as **remote MCP servers**.
19+
20+
<Callout type="info">
21+
<Icon icon="bolt" iconType="solid" /> **Quick Setup** – Use the configuration below to get started with Context7 in your preferred environment.
22+
</Callout>
1923

2024
<Tabs items={['Cursor', 'Windsurf', 'VSCode', 'Claude Desktop']}>
2125
<Tab title="Cursor">
@@ -79,7 +83,7 @@ Context7 automatically ingests popular open‑source libraries (and many private
7983
</Tab>
8084
</Tabs>
8185

82-
#### Example: Using Context7 with Three.js
86+
#### <Icon icon="lightbulb" iconType="solid" /> Example: Using Context7 with Three.js
8387

8488
After installing Context7, you can prompt your AI assistant to use Three.js documentation like this:
8589

@@ -88,11 +92,15 @@ Can you help me create a basic Three.js scene with a rotating cube?
8892
Use context7
8993
```
9094

91-
The AI will then dynamically query Context7 for relevant Three.js documentation as it helps you.
95+
The AI will then **dynamically query Context7** for relevant Three.js documentation as it helps you.
9296

9397
### <Icon icon="code-branch" iconType="solid" /> GitMCP.io
9498

95-
[GitMCP](https://gitmcp.io) lets you turn **any public GitHub repository** into a fully‑featured MCP server just by changing the domain from `github.com``gitmcp.io` (or `github.io``gitmcp.io`). No build step, no package installs.
99+
[**GitMCP**](https://gitmcp.io) lets you turn **any public GitHub repository** into a fully‑featured MCP server just by changing the domain from `github.com``gitmcp.io` (or `github.io``gitmcp.io`). **No build step, no package installs.**
100+
101+
<Callout type="tip">
102+
<Icon icon="wand-magic-sparkles" iconType="solid" /> **Pro Tip** – Simply change GitHub URLs to GitMCP URLs to instantly access documentation!
103+
</Callout>
96104

97105
<Tabs items={['Cursor', 'Windsurf', 'VSCode', 'Claude Desktop']}>
98106
<Tab title="Cursor">
@@ -146,32 +154,34 @@ The AI will then dynamically query Context7 for relevant Three.js documentation
146154
</Tab>
147155
</Tabs>
148156

149-
## Example: Three.js Documentation
157+
## <Icon icon="vial" iconType="solid" /> Example: Three.js Documentation
150158

151159
Once either MCP server is configured, the following **single‑shot prompt** in Cursor + Claude illustrates the improvement:
152160

153161
> Build a Three.js scene featuring a controllable realistic person navigating a textured dynamic urban environment with realistic lighting and subtle bloom effects. Ensure keyboard controls (WASD) for movement.
154162
155-
### Side‑by‑Side Result (GitMCP vs. No GitMCP)
163+
### <Icon icon="code-compare" iconType="solid" /> Side‑by‑Side Result (GitMCP vs. No GitMCP)
156164

157165
<iframe
158166
src="gitmcp-threejs.mp4"
159167
title="GitMCP vs No GitMCP – Three.js demo"
160168
width="550"
161169
height="206"
170+
allow="autoplay; fullscreen;"
171+
autoplay
162172
style={{ width: '100%', height: 'auto', aspectRatio: '2872/1080', border: '0', borderRadius: '0.5rem' }}
163173
></iframe>
164174

165175
<Callout type="info">
166176
<Icon icon="info-circle" iconType="solid" /> **Why it matters** – by streaming the full Three.js documentation on demand, GitMCP gives the LLM precise API details (e.g. `GLTFLoader`, `DirectionalLight.castShadow`, `EffectComposer`) that would otherwise be unavailable or outdated, resulting in dramatically higher‑quality code generation.
167177
</Callout>
168178

169-
## Benefits of GitHub-Powered MCP Servers
179+
## <Icon icon="star" iconType="solid" /> Benefits of GitHub-Powered MCP Servers
170180

171181
These tools offer several advantages:
172182

173-
- **Zero Documentation Effort**: Use existing documentation from any GitHub repository
174-
- **Always Up-to-Date**: Documentation is pulled directly from the latest repository version
175-
- **On-Demand Access**: AI assistants query only what they need when they need it
176-
- **Broad Compatibility**: Works with virtually any open-source project on GitHub
177-
- **Simplified Integration**: Easy to add to your IDE or AI assistant
183+
- <Icon icon="check" iconType="solid" /> **Zero Documentation Effort**: Use existing documentation from any GitHub repository
184+
- <Icon icon="newspaper" iconType="solid" /> **Always Up-to-Date**: Documentation is pulled directly from the latest repository version
185+
- <Icon icon="bolt" iconType="solid" /> **On-Demand Access**: AI assistants query only what they need when they need it
186+
- <Icon icon="puzzle-piece" iconType="solid" /> **Broad Compatibility**: Works with virtually any open-source project on GitHub
187+
- <Icon icon="code" iconType="solid" /> **Simplified Integration**: Easy to add to your IDE or AI assistant

doc-generators/mcp-compatible-generators.mdx

Lines changed: 52 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,55 @@ icon: "star"
55
iconType: "solid"
66
---
77

8-
MCP-compatible documentation generators are specialized tools designed with features that support documenting AI-related projects, specifically those following the Machine-Controlled Program (MCP) pattern.
9-
10-
## Available Generators
11-
12-
- <Icon icon="leaf" iconType="solid" /> **[Mintlify](https://mintlify.com/)**: A modern documentation platform used by this site, with built-in support for AI-related content and interactive examples
13-
14-
- <Icon icon="microphone-alt" iconType="solid" /> **[Speakeasy](https://www.speakeasyapi.dev/)**: API documentation generator with special features for documenting AI endpoints and capabilities
15-
16-
- <Icon icon="shield-alt" iconType="solid" /> **[Stainless](https://stainlessapi.com/)**: Documentation tooling focused on robust API references and SDK documentation for MCP services
17-
18-
## Features and Benefits
19-
20-
These documentation tools provide specialized features for describing, demonstrating, and documenting the unique aspects of MCP applications like:
21-
22-
- API endpoints for AI services
23-
- Model capabilities and limitations
24-
- AI interaction patterns and prompting strategies
25-
- Integration guidelines for LLM-powered applications
26-
- Context window management documentation
27-
- Tool specifications and schemas
28-
29-
## When to Use
30-
31-
Choose these specialized documentation generators when:
32-
33-
- Building AI-first applications that need clear documentation
34-
- Creating API reference materials for LLM services
35-
- Documenting prompt engineering guidelines
36-
- Providing examples of AI tool usage patterns
37-
- Sharing best practices for MCP integration
8+
MCP-compatible documentation generators are specialized tools designed with features that support documenting AI-related projects, specifically those following the **Machine-Controlled Program (MCP)** pattern.
9+
10+
## <Icon icon="tools" iconType="solid" /> Available Generators
11+
12+
- <Icon icon="leaf" iconType="solid" color="#22c55e" /> **[Mintlify](https://mintlify.com/)**: A modern documentation platform used by this site, with built-in support for AI-related content and interactive examples. Mintlify can generate MCP servers directly from your documentation, enabling:
13+
- <Icon icon="robot" iconType="solid" /> **AI-accessible documentation** for contextual answers
14+
- <Icon icon="bolt" iconType="solid" /> **Real-time API querying** through OpenAPI specifications
15+
- <Icon icon="code" iconType="solid" /> **Structured formats** like `/llms.txt` for AI-friendly indexing
16+
- <Icon icon="file-lines" iconType="solid" /> **Precompiled context files** for LLMs to efficiently access your documentation
17+
18+
<Note>
19+
<Icon icon="circle-info" iconType="solid" /> This entire website is generated using **Mintlify** and can be accessed through its autogenerated MCP docs server - providing a meta example of MCP documentation that documents MCP tools.
20+
</Note>
21+
22+
- <Icon icon="microphone" iconType="solid" color="#3b82f6" /> **[Speakeasy](https://www.speakeasyapi.dev/)**: API documentation generator with special features for documenting AI endpoints and capabilities
23+
24+
- <Icon icon="shield" iconType="solid" color="#ef4444" /> **[Stainless](https://stainlessapi.com/)**: Documentation tooling focused on robust API references and SDK documentation for MCP services
25+
26+
## <Icon icon="list-check" iconType="solid" /> Features and Benefits
27+
28+
These documentation tools provide **specialized features** for describing, demonstrating, and documenting the unique aspects of MCP applications like:
29+
30+
<CardGroup >
31+
<Card icon="wifi" title="API Endpoints">
32+
Comprehensive documentation for AI services
33+
</Card>
34+
<Card icon="brain" title="Model Capabilities">
35+
Document capabilities and limitations clearly
36+
</Card>
37+
<Card icon="message-bot" title="Interaction Patterns">
38+
AI interaction patterns and prompting strategies
39+
</Card>
40+
<Card icon="puzzle-piece" title="Integration Guidelines">
41+
Best practices for LLM-powered applications
42+
</Card>
43+
<Card icon="expand" title="Context Management">
44+
Window management documentation for LLMs
45+
</Card>
46+
<Card icon="screwdriver-wrench" title="Tool Specifications">
47+
Schemas and usage details for AI tools
48+
</Card>
49+
</CardGroup>
50+
51+
## <Icon icon="clock" iconType="solid" /> When to Use
52+
53+
Choose these **specialized documentation generators** when:
54+
55+
- <Icon icon="rocket" iconType="solid" /> Building **AI-first applications** that need clear documentation
56+
- <Icon icon="book-open-reader" iconType="solid" /> Creating **API reference materials** for LLM services
57+
- <Icon icon="message" iconType="solid" /> Documenting **prompt engineering guidelines**
58+
- <Icon icon="code-compare" iconType="solid" /> Providing **examples of AI tool usage patterns**
59+
- <Icon icon="share-nodes" iconType="solid" /> Sharing **best practices for MCP integration**

0 commit comments

Comments
 (0)