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 許可證。