developer

---

使用 doc2mcp 的三种方式

方式	最适合	从这里开始
网页	在浏览器中即时转换	doc2mcp.site
CLI	终端操作 + 一键安装到 Cursor	npm i -g doc2mcp
SDK	代码、CI、LangChain / LangGraph / Agent	doc2mcp-sdk

API 密钥始终来自 doc2mcp.site（用户 PAT + 项目令牌）。SDK 无需单独登录。

---

流程

文档 URL → 抓取 → 分析 → MCP 工具 → 托管端点 → Cursor / Claude / LangChain / LangGraph。

---

1) 网页（常规方式）

1. 在 doc2mcp.site/login 登录
2. 粘贴文档 URL（Stripe、LangChain、Mintlify、GitHub……）
3. 将托管 MCP URL + Bearer 令牌复制到 Cursor / Claude / VS Code

{
  "mcpServers": {
    "my-docs": {
      "url": "https://doc2mcp.site/api/mcp/{project_id}/mcp",
      "headers": { "Authorization": "Bearer <project-token>" }
    }
  }
}

---

2) CLI

npm install -g doc2mcp
doc2mcp login                 # creates User PAT (d2mcp_pat_…)
doc2mcp https://docs.example.com

列出与控制面板中相同的项目。安装 Cursor / VS Code / Claude / Windsurf 的辅助工具。

---

3) SDK（doc2mcp-sdk）

npm i doc2mcp-sdk

import { Doc2MCP } from "doc2mcp-sdk";

// User PAT from doc2mcp.site / `npx doc2mcp login` — SDK has no auth of its own
const client = new Doc2MCP({ token: process.env.DOC2MCP_API_TOKEN! }); // Settings → d2mcp_usr_…

const ready = await client.convertAndWait({
  sourceUrl: "https://js.langchain.com/docs",
});

const answer = await client.callToolText({
  mcpUrl: ready.mcp.url,
  mcpToken: ready.mcp.token, // project token d2mcp_…
  name: "search_documentation",
  arguments: { query: "how do runnables work?" },
});

完整手册（API 密钥、Cursor、Claude、LangChain、LangGraph、LangSmith、OpenAI、Vercel AI SDK、CrewAI、AutoGen、Mastra）：

doc2mcp/doc2mcp-sdk → docs/

产品文档页面：doc2mcp.site/docs/sdk

---

每个项目生成的 MCP 工具

工具	功能
list_documentation_pages	所有已抓取的页面
get_documentation_page	单个页面的完整 Markdown
search_documentation	可识别标题的搜索
get_documentation_overview	摘要 + 索引
read_full_documentation	合并后的所有页面
ask_documentation	带引用的问答

仓库

仓库	用途
doc2mcp/doc2mcp（本仓库）	Next.js 应用、CLI、流程、MCP 运行时
doc2mcp/doc2mcp-sdk	编程用 JS/TS SDK + 框架示例
doc2mcp/doc2mcp-registry	MCP Registry 网关清单

参与贡献

1. 阅读 CONTRIBUTING.md 和 CODE_OF_CONDUCT.md
2. 从 staging 创建分支 → 提交 PR → 合并到 staging
3. AI 审查（Gemini PR review）遇到必须修复的问题时检查会失败——合并前请修复阻塞问题
4. 使用优惠码 opensourcedoc2mcp → 在 定价 页面领取 Starter 套餐，免费使用 12 个月

更多信息：doc2mcp.site/open-source

本地开发

pnpm install
cp .env.example .env.local
pnpm dev

pnpm check
pnpm exec tsc --noEmit --skipLibCheck

CI / CD

功能分支 → staging（预览）→ main → v* 标签会在 Vercel 上部署到生产环境。

PR 检查：Biome/Ultracite、TypeScript、Next 构建、CLI 构建、Gemini AI 审查（必须修复的问题 → 检查失败）。

许可证

MIT — 参见 LICENSE。