Fumadocs MCP

🚀 Fumadocs MCP 服务器

Fumadocs MCP 服务器是一个基于模型上下文协议（MCP）的服务器，它为人工智能工具提供了访问 Fumadocs 文档的途径。这使得 AI 助手能够更轻松地帮助你将 Fumadocs 集成到现有项目中。

🚀 快速开始

Fumadocs MCP 服务器提供了便捷的方式让 AI 工具访问 Fumadocs 文档。你可以按照以下步骤快速开始使用。

✨ 主要特性

• 搜索文档 - 通过关键词查找相关文档。
• 浏览主题 - 探索文档的各个部分。
• 获取页面 - 获取任何文档页面的完整内容。
• 设置指南 - 获取特定框架的安装说明。
• 组件文档 - 获取带有属性和示例的 UI 组件文档。

📦 安装指南

使用 npx（推荐）

npx fumadocs-mcp

全局安装

npm install -g fumadocs-mcp
fumadocs-mcp

从源代码安装

git clone https://github.com/k4cper-g/fumadocs-mcp
cd fumadocs-mcp
npm install
npm run build

📚 详细文档

配置

Claude Desktop

将以下内容添加到你的 Claude Desktop 配置文件中：

• macOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "fumadocs": {
      "command": "npx",
      "args": ["fumadocs-mcp"]
    }
  }
}

或者，如果你是从源代码安装的：

{
  "mcpServers": {
    "fumadocs": {
      "command": "node",
      "args": ["/path/to/fumadocs-mcp/build/index.js"]
    }
  }
}

Claude Code

当在 Claude Desktop 中完成配置后，MCP 将自动可用。

可用工具

list_topics

浏览可用的文档部分和主题。

参数:
- section（可选）: "all" | "cli" | "headless" | "framework" | "mdx" | "ui"

search_docs

通过关键词搜索文档。

参数:
- query（必需）: 搜索查询字符串
- section（可选）: 过滤到特定部分

get_page

获取文档页面的完整内容。

参数:
- path（必需）: 文档路径（例如，"/docs/manual-installation/next"）

get_setup_guide

获取将 Fumadocs 添加到现有项目的完整设置指南。

参数:
- framework（必需）: "next" | "react-router" | "tanstack-start" | "waku"
- includeUI（可选）: 是否包含 UI 设置说明（默认: true）

get_component

获取特定 UI 组件的文档。

参数:
- component（必需）: 组件名称（例如，"accordion", "tabs", "codeblock"）

💻 使用示例

配置完成后，你可以向 Claude 询问如下问题：

• "如何将 Fumadocs 添加到我现有的 Next.js 项目中？"
• "向我展示如何在 Fumadocs 中使用 Tabs 组件"
• "搜索有关国际化的文档"
• "Fumadocs UI 中有哪些可用组件？"

🔧 技术细节

开发

# 安装依赖
npm install

# 构建
npm run build

# 以开发模式运行
npm run dev

# 使用 MCP 检查器进行测试
npm run inspector

📄 许可证

本项目采用 MIT 许可证。