You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: doc-generators/custom-doc-generators.mdx
+57-5Lines changed: 57 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,6 +65,36 @@ Key benefits include:
65
65
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.
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:
78
108
79
109
To create your own MCP documentation server using AutoRAG:
80
110
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
+
<Steptitle="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
+
<Steptitle="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
+
<Steptitle="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
+
<Steptitle="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
+
<Steptitle="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>
86
132
87
133
<Tip>
88
134
Start with a small subset of your documentation to test the system before scaling to your entire knowledge base.
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
+
91
143
## <Iconicon="circle-check"iconType="solid"color="#10B981" /> When to Choose Custom Solutions
92
144
93
145
Custom documentation generators are most valuable when:
Copy file name to clipboardExpand all lines: doc-generators/github-powered-servers.mdx
+24-14Lines changed: 24 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,17 +5,21 @@ icon: "github"
5
5
iconType: "brands"
6
6
---
7
7
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.
9
9
10
10
<Callouttype="warning">
11
11
<Iconicon="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.
12
12
</Callout>
13
13
14
-
## Available Tools
14
+
## <Iconicon="toolbox"iconType="solid" /> Available Tools
[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
+
<Callouttype="tip">
102
+
<Iconicon="wand-magic-sparkles"iconType="solid" /> **Pro Tip** – Simply change GitHub URLs to GitMCP URLs to instantly access documentation!
Once either MCP server is configured, the following **single‑shot prompt** in Cursor + Claude illustrates the improvement:
152
160
153
161
> 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.
154
162
155
-
### Side‑by‑Side Result (GitMCP vs. No GitMCP)
163
+
### <Iconicon="code-compare"iconType="solid" /> Side‑by‑Side Result (GitMCP vs. No GitMCP)
<Iconicon="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.
167
177
</Callout>
168
178
169
-
## Benefits of GitHub-Powered MCP Servers
179
+
## <Iconicon="star"iconType="solid" /> Benefits of GitHub-Powered MCP Servers
170
180
171
181
These tools offer several advantages:
172
182
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
+
-<Iconicon="check"iconType="solid" /> **Zero Documentation Effort**: Use existing documentation from any GitHub repository
184
+
-<Iconicon="newspaper"iconType="solid" /> **Always Up-to-Date**: Documentation is pulled directly from the latest repository version
185
+
-<Iconicon="bolt"iconType="solid" /> **On-Demand Access**: AI assistants query only what they need when they need it
186
+
-<Iconicon="puzzle-piece"iconType="solid" /> **Broad Compatibility**: Works with virtually any open-source project on GitHub
187
+
-<Iconicon="code"iconType="solid" /> **Simplified Integration**: Easy to add to your IDE or AI assistant
Copy file name to clipboardExpand all lines: doc-generators/mcp-compatible-generators.mdx
+52-30Lines changed: 52 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,33 +5,55 @@ icon: "star"
5
5
iconType: "solid"
6
6
---
7
7
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
-
- <Iconicon="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
-
- <Iconicon="microphone-alt"iconType="solid" /> **[Speakeasy](https://www.speakeasyapi.dev/)**: API documentation generator with special features for documenting AI endpoints and capabilities
15
-
16
-
- <Iconicon="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
+
## <Iconicon="tools"iconType="solid" /> Available Generators
11
+
12
+
- <Iconicon="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
+
- <Iconicon="robot"iconType="solid" /> **AI-accessible documentation** for contextual answers
14
+
- <Iconicon="bolt"iconType="solid" /> **Real-time API querying** through OpenAPI specifications
15
+
- <Iconicon="code"iconType="solid" /> **Structured formats** like `/llms.txt` for AI-friendly indexing
16
+
- <Iconicon="file-lines"iconType="solid" /> **Precompiled context files** for LLMs to efficiently access your documentation
17
+
18
+
<Note>
19
+
<Iconicon="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
+
- <Iconicon="microphone"iconType="solid"color="#3b82f6" /> **[Speakeasy](https://www.speakeasyapi.dev/)**: API documentation generator with special features for documenting AI endpoints and capabilities
23
+
24
+
- <Iconicon="shield"iconType="solid"color="#ef4444" /> **[Stainless](https://stainlessapi.com/)**: Documentation tooling focused on robust API references and SDK documentation for MCP services
25
+
26
+
## <Iconicon="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:
0 commit comments