README
🚀 Docfork:为你的AI代码编辑器提供🌿最新文档
Docfork可通过单个MCP为你的AI代码编辑器提供9000多个库的最新文档。
🚀 快速开始
❌ 问题:知识过期
- 代码过时和数据陈旧
- API 形同虚设且存在幻觉问题
- 版本过旧或不匹配
✅ 解决方案:极速获取最新文档
- 始终与最新版本的文档保持同步
- 提供准确的描述和代码示例
- 在你的AI代码编辑器中实现亚秒级检索结果
只需告诉Cursor use docfork 即可。
Create a basic Next.js app with the App Router. use docfork
📦 安装指南
📋 要求
- Node.js ≥ v18
- Cursor/Windsurf/Claude Desktop(任何MCP客户端)
⚡ 在Cursor中安装
或者手动安装:
设置->Cursor设置->MCP工具- 添加新的MCP服务器
- 也可以通过
.cursor/mcp.json进行项目级配置
推荐设置:
将以下内容添加到全局 ~/.cursor/mcp.json(或项目级的 ./.cursor/mcp.json)中:
Cursor远程服务器连接
{
"mcpServers": {
"docfork": {
"url": "https://mcp.docfork.com/mcp"
}
}
}
Cursor本地服务器连接
{
"mcpServers": {
"docfork": {
"command": "npx",
"args": ["-y", "docfork"]
}
}
}
替代方案:使用Bun
{
"mcpServers": {
"docfork": {
"command": "bunx",
"args": ["-y", "docfork"]
}
}
}
替代方案:使用Deno
{
"mcpServers": {
"docfork": {
"command": "deno",
"args": ["run", "--allow-env", "--allow-net", "npm:docfork"]
}
}
}
通过Smithery安装
通过Smithery安装
要通过 Smithery 自动为任何客户端安装Docfork MCP服务器,请执行以下命令:
npx -y @smithery/cli@latest install @docfork/mcp --client <CLIENT_NAME> --key <YOUR_SMITHERY_KEY>
你可以在 Smithery.ai网页 上找到你的Smithery密钥。
在Windsurf中安装
在Windsurf中安装
将以下内容添加到你的Windsurf MCP配置中。更多信息请参阅 Windsurf MCP文档。
Windsurf远程服务器连接
{
"mcpServers": {
"docfork": {
"serverUrl": "https://mcp.docfork.com/sse"
}
}
}
Windsurf本地服务器连接
{
"mcpServers": {
"docfork": {
"command": "npx",
"args": ["-y", "docfork"]
}
}
}
在VS Code中安装
在VS Code中安装
将以下内容添加到你的VS Code MCP配置中。更多信息请参阅 VS Code MCP文档。
VS Code远程服务器连接
{
"mcpServers": {
"docfork": {
"type": "http",
"url": "https://mcp.docfork.com/mcp"
}
}
}
VS Code本地服务器连接
{
"servers": {
"docfork": {
"type": "stdio",
"command": "npx",
"args": ["-y", "docfork"]
}
}
}
在Zed中安装
在Zed中安装
一键安装: → 获取 Docfork扩展
或者手动配置(适用于高级用户):
{
"context_servers": {
"docfork": {
"command": {
"path": "npx",
"args": ["-y", "docfork"]
},
"settings": {}
}
}
}
在Claude Code中安装
在Claude Code中安装
运行以下命令。更多信息请参阅 Claude Code MCP文档。
Claude Code远程服务器连接
claude mcp add --transport sse docfork https://mcp.docfork.com/sse
Claude Code本地服务器连接
claude mcp add docfork -- npx -y docfork
在Claude Desktop中安装
在Claude Desktop中安装
将以下内容添加到你的Claude Desktop claude_desktop_config.json 文件中。更多信息请参阅 Claude Desktop MCP文档。
{
"mcpServers": {
"docfork": {
"command": "npx",
"args": ["-y", "docfork"]
}
}
}
在BoltAI中安装
在BoltAI中安装
打开应用的“设置”页面,导航到“插件”,并输入以下JSON:
{
"mcpServers": {
"docfork": {
"command": "npx",
"args": ["-y", "docfork"]
}
}
}
更多信息可在 BoltAI的文档网站 上找到。对于iOS版的BoltAI,请参阅 此指南。
使用Docker
使用Docker
如果你更喜欢在Docker容器中运行MCP服务器,请按以下步骤操作:
- 构建Docker镜像:
首先,在项目根目录(或你喜欢的任何位置)创建一个
Dockerfile:
点击查看Dockerfile内容
FROM node:18-alpine
WORKDIR /app
# 全局安装最新版本
RUN npm install -g docfork
# 如果需要,暴露默认端口(可选,取决于MCP客户端交互)
# EXPOSE 3000
# 运行服务器的默认命令
CMD ["docfork"]
然后,使用一个标签(例如 docfork-mcp)构建镜像。确保Docker Desktop(或Docker守护进程)正在运行。在保存 Dockerfile 的同一目录中运行以下命令:
docker build -t docfork .
- 配置你的MCP客户端: 更新你的MCP客户端配置以使用Docker命令。
cline_mcp_settings.json 的示例:
{
"mcpServers": {
"docfork": {
"autoApprove": [],
"disabled": false,
"timeout": 60,
"command": "docker",
"args": ["run", "-i", "--rm", "docfork-mcp"],
"transportType": "stdio"
}
}
}
注意:这是一个示例配置。请参考本README前面针对你的MCP客户端(如Cursor、VS Code等)的具体示例来调整结构(例如 mcpServers 与 servers)。此外,确保 args 中的镜像名称与 docker build 命令中使用的标签相匹配。
在Windows中安装
在Windows中安装
Windows上的配置与Linux或macOS略有不同(示例中使用了 Cline)。同样的原则适用于其他编辑器;请参考 command 和 args 的配置。
{
"mcpServers": {
"github.com/docfork/mcp": {
"command": "cmd",
"args": ["/c", "npx", "-y", "docfork@latest"],
"disabled": false,
"autoApprove": []
}
}
}
在Augment Code中安装
在Augment Code中安装
要在Augment Code中配置Docfork MCP,请按以下步骤操作:
- 按下Cmd/Ctrl Shift P或在Augment面板中打开汉堡菜单
- 选择“编辑设置”
- 在“高级”下,点击“在settings.json中编辑”
- 将服务器配置添加到
augment.advanced对象中的mcpServers数组中
"augment.advanced": {
"mcpServers": [
{
"name": "docfork",
"command": "npx",
"args": ["-y", "docfork"]
}
]
}
添加MCP服务器后,重启你的编辑器。如果你收到任何错误,请检查语法,确保没有遗漏右括号或逗号。
在Roo Code中安装
在Roo Code中安装
将以下内容添加到你的Roo Code MCP配置文件中。更多信息请参阅 Roo Code MCP文档。
Roo Code远程服务器连接
{
"mcpServers": {
"docfork": {
"type": "streamable-http",
"url": "https://mcp.docfork.com/mcp"
}
}
}
Roo Code本地服务器连接
{
"mcpServers": {
"docfork": {
"command": "npx",
"args": ["-y", "docfork"]
}
}
}
🔧 技术细节
环境变量
Docfork MCP服务器支持以下环境变量:
DEFAULT_MINIMUM_TOKENS:设置文档检索的最小令牌数(默认值:10000)
带有环境变量的示例配置:
{
"mcpServers": {
"docfork": {
"command": "npx",
"args": ["-y", "docfork@latest"],
"env": {
"DEFAULT_MINIMUM_TOKENS": "10000"
}
}
}
}
可用工具
Docfork MCP提供了以下可供大语言模型使用的工具:
get-library-docs:搜索库并返回其文档。libraryName(必需):要搜索的库的名称topic(必需):将文档聚焦于特定主题(例如,“路由”、“钩子”)tokens(可选,默认值10000,最大值50000):要返回的最大令牌数。小于配置的DEFAULT_MINIMUM_TOKENS值或默认值10000的值将自动增加到该值。
开发
克隆项目并安装依赖:
npm i
构建项目:
npm run build
本地配置示例
{
"mcpServers": {
"docfork": {
"command": "npx",
"args": ["tsx", "/path/to/folder/docfork/src/index.ts"]
}
}
}
使用MCP Inspector进行测试
npx -y @modelcontextprotocol/inspector npx docfork
故障排除
模块未找到错误
如果你遇到 ERR_MODULE_NOT_FOUND 错误,尝试使用 bunx 代替 npx:
{
"mcpServers": {
"docfork": {
"command": "bunx",
"args": ["-y", "docfork"]
}
}
}
这通常可以解决在 npx 无法正确安装或解析包的环境中的模块解析问题。
ESM解析问题
对于像 Error: Cannot find module 'uriTemplate.js' 这样的错误,尝试使用 --experimental-vm-modules 标志:
{
"mcpServers": {
"docfork": {
"command": "npx",
"args": ["-y", "--node-options=--experimental-vm-modules", "docfork"]
}
}
}
常见MCP客户端错误故障排除
- 在包名后追加
@latest以获取最新版本。 - 如果命令停滞或失败,将
npx替换为bunx。 - 当遇到打包器问题时,优先使用Deno作为替代方案。
- 确保你使用的是Node.js v18+,以便
fetch可以原生使用。
⚠️ 免责声明
Docfork是一个开放的、社区驱动的目录。尽管我们会审查提交内容,但我们不对任何链接文档或代码的准确性、完整性或安全性作出明示或暗示的保证。此处列出的项目由其各自的作者创建和维护,而非Docfork。
如果你发现可疑、不适当或潜在有害的内容,请与我们联系。
使用Docfork即表示你同意自行决定并承担使用风险。
🌟 与我们联系
保持关注并加入社区:
- 🐦 在X上关注我们 → @docfork_ai,获取产品新闻和更新
- 🌐 访问我们的 网站
星标历史
📄 许可证
本项目采用MIT许可证。
微信扫一扫