关于 ContextMCP
ContextMCP 是可自托管的 MCP 服务器,将文档索引为可搜索的知识库,并通过 MCP 与 REST API 提供访问。适合希望让 AI 助手查询自有文档的团队与开发者,基于 Apache License 2.0 开源。
主要功能
- 01解析 MDX、Markdown 与 OpenAPI 文档
- 02语义分块并生成向量嵌入
- 03使用 Pinecone 存储向量数据
- 04通过 MCP 与 REST API 提供搜索
适用场景
- 01让 AI 助手查询产品文档与 API 参考
- 02为文档站点添加可嵌入的 AI 问答组件
- 03使用 npx contextmcp init 快速搭建文档 MCP 项目
MCP 相关
该项目是一个 MCP 服务器,向 MCP 客户端暴露文档搜索能力,AI 助手可通过 MCP 查询已索引的文档内容。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
ContextMCP
面向文档的可自托管 MCP 服务。 从各种来源为文档编制索引,并通过 Model Context Protocol (MCP) 和 REST API 提供服务。
快速开始
# Scaffold a new project
npx contextmcp init my-docs-mcp
# Follow the prompts, then:
cd my-docs-mcp
npm install
# Configure your API keys
cp .env.example .env
# Edit .env with your PINECONE_API_KEY and an embedding provider key
# (OPENAI_API_KEY for provider: openai, or GEMINI_API_KEY for provider: gemini)
# Configure your documentation sources
# Edit config.yaml
# Index your documentation
npm run reindex
# Edit the cloudflare-worker
# Deploy the MCP server
cd cloudflare-worker
npm install
npm run deploy
什么是 ContextMCP?
ContextMCP 根据你的文档构建可搜索的知识库,AI 助手可以通过 Model Context Protocol (MCP) 查询这些内容。
支持的内容类型
| 解析器 | 内容类型 | 示例 |
|---|---|---|
mdx | MDX/JSX 文档 | Mintlify、Fumadocs、Docusaurus |
markdown | 纯 Markdown 文件 | README、CHANGELOG |
openapi | OpenAPI/Swagger 规范 | API 参考文档 |
工作原理
- 解析 - 从文档、API 和 README 中提取内容
- 分块 - 拆分为适合搜索的语义片段
- 嵌入 - 使用 OpenAI 或 Gemini 生成嵌入
- 存储 - 上传至 Pinecone 向量数据库
- 搜索 - AI 助手通过 MCP 查询
生态系统
使用 ContextChat 添加聊天 UI
ContextMCP 提供检索功能;搭配 ContextChat,即可为文档添加开箱即用、可嵌入的“询问 AI”小组件。ContextChat 是一个 Cloudflare Worker,可查询 ContextMCP 的 /search 端点,并以流式方式返回带有行内引用的回答——只需添加一个 <script> 标签,即可将其接入任何网站或文档页面。
仓库结构
contextmcp/
├── packages/
│ ├── cli/ # npx contextmcp (npm package)
│ ├── template/ # Project template (scaffolded to users)
│ └── website/ # contextmcp.ai documentation site
└── deployments/
└── dodopayments/ # Dodo Payments specific deployment
软件包
| 软件包 | 说明 | 发布状态 |
|---|---|---|
packages/cli | CLI 脚手架工具 | ✅ npm:contextmcp |
packages/template | 项目模板 | (由 CLI 复制) |
packages/website | 文档网站 | (部署至 Vercel) |
开发
先决条件
- Node.js 18+
设置
# Install all dependencies
npm install
# Development
npm run dev:website # Run website locally
npm run dev:cli # Watch CLI for changes
# Build
npm run build:website # Build website
npm run build:cli # Build CLI
# Type checking
npm run typecheck # Check all packages
文档
访问 contextmcp.ai/docs 查看完整文档。
贡献
欢迎贡献!请参阅 CONTRIBUTING.md,了解如何为本项目作出贡献。
许可证
本项目采用 Apache License 2.0 许可,详情请参阅 LICENSE 文件。
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。