Arabold Docs MCP Server

🚀 文檔

docs-mcp 是一款用於管理和控制文檔的 Model Context Protocol (MCP) 服務器，它提供了文檔存儲管理、版本控制等功能，支持多種格式和遠程交互，還具備豐富的擴展性。

🚀 快速開始

docs-mcp 是一個用於管理和控制文檔的 Model Context Protocol (MCP) 服務器。你可以按照以下步驟快速開啟使用：

# 克隆倉庫
git clone https://github.com/modelcontextprotocol/docs-mcp.git
cd docs-mcp

# 安裝依賴
npm install

# 啟動開發服務器
npm run dev

# 編譯項目
npm run build

# 啟動 docs-mcp 服務器
node dist/server.js --port 3000

✨ 主要特性

1. 文檔存儲與管理

   • 文檔以層次結構的形式組織，支持多種格式（如 Markdown、JSON 等）。
   • 支持通過 MCP 協議進行遠程文檔交互。

2. 版本控制

   • 每個文檔都有唯一的版本號和變更歷史。
   • 支持基於語義化的版本控制系統。

3. 擴展性

   • 提供豐富的插件接口，支持自定義功能擴展。
   • 支持與多種工具和服務集成（如 CI/CD、IDE 等）。

📦 安裝指南

請參考 INSTALL.md。

💻 使用示例

基礎用法

以下是一個簡單的使用示例：

# 啟動 docs-mcp 服務器
node dist/server.js --port 3000

# 使用文檔管理功能
curl -X POST http://localhost:3000/docs/create \
     -H "Content-Type: application/json" \
     -d '{"title": "我的第一個文檔", "content": "這是我的第一個文檔內容"}'

# 查看文檔列表
curl http://localhost:3000/docs/list

# 獲取特定文檔
curl http://localhost:3000/docs/[doc_id]

# 更新文檔
curl -X PUT http://localhost:3000/docs/[doc_id] \
     -H "Content-Type: application/json" \
     -d '{"title": "更新後的標題", "content": "這是更新後的內容"}'

# 刪除文檔
curl -X DELETE http://localhost:3000/docs/[doc_id]

高級用法

以下是 docs-mcp 可用的完整命令行選項：

• 啟動服務器

  node dist/server.js [--port <端口>] [--env <環境>]
  

  • --port: 指定服務器監聽的端口，默認為 3000。
  • --env: 指定運行環境（如 development、production 等），默認為 development。

• 文檔管理命令

  npm run docs-mcp <command> [-- <args...>]
  
  命令:
    create       創建新文檔
    list         列出所有文檔
    get          獲取特定文檔
    update       更新現有文檔
    delete       刪除文檔
  

📚 詳細文檔

文檔版本控制

docs-mcp 支持基於語義化的版本控制系統。每次文檔更新時，都會自動生成新的版本號，並記錄變更歷史。

擴展與插件

docs-mcp 提供了豐富的插件接口，允許開發者根據需要擴展功能。例如：

• 日誌插件

  const { Logger } = require('@modelcontextprotocol/mcp-core').Logger;
  
  module.exports = {
    logger: new Logger({
      level: 'debug',
      handlers: [
        // 添加自定義日誌處理器
      ],
    }),
  };
  

• 認證插件

  const { Auth } = require('@modelcontextprotocol/mcp-core').Auth;
  
  module.exports = {
    auth: new Auth({
      provider: 'custom',
      // 配置自定義認證提供程序
    }),
  };
  

示例項目

如需查看更多示例，請訪問 DOCS-MCP 示例。

代碼結構概述

docs-mcp/
├── src/                 # 源代碼目錄
│   ├── server.js       # 主服務器文件
│   ├── commands/       # 命令行處理模塊
│   └── plugins/        # 插件系統實現
├── dist/               # 編譯輸出目錄
├── package.json        # 項目依賴和配置
└── .env.example        # 環境變量示例文件

貢獻指南

如需為 docs-mcp 做貢獻，請參考 CONTRIBUTING.md。

問題與支持

如遇問題，請訪問 DOCS-MCP 問題跟蹤 提交反饋或提問。

⚠️ 重要提示

本項目為實驗性質，尚未完全穩定，使用前請仔細閱讀相關文檔並做好數據備份。