Dust

🚀 MCP 服務器指南

MCP Server 是一個用於管理任務控制協議（Mission Control Protocol）的工具，它提供了創建會話、發送消息和檢索消息的功能，並支持通過 curl 請求進行交互。

🚀 快速開始

要使用 MCP Server，你需要先完成安裝和配置，然後就可以啟動服務器並進行交互了。

✨ 主要特性

• 支持多操作系統，包括 Linux、macOS 和 Windows。
• 可通過 config.json 文件或環境變量進行靈活配置。
• 提供豐富的命令行選項，方便啟動服務器和進行日誌記錄。
• 支持通過 curl 請求進行 API 交互，如創建會話、發送消息和檢索消息。

📦 安裝指南

先決條件

• 操作系統：Linux、macOS 或 Windows（推薦使用 Linux）
• Python 版本：3.6 或更高版本
• Git：用於克隆代碼庫

克隆倉庫

運行以下命令來克隆 MCP Server 倉庫：

git clone https://github.com/yourusername/mcp-server.git
cd mcp-server

安裝依賴項

使用 pip 安裝所需的 Python 包：

pip install -r requirements.txt

啟動服務器

安裝完成後，運行以下命令啟動 MCP Server：

python3 server.py --help

💻 使用示例

基礎用法

創建會話

curl -X POST "http://localhost:5000/api/v1/conversations" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "系統思考對話",
    "model": "claude-3-5-sonnet-20240620"
  }'

發送消息

curl -X POST "http://localhost:5000/api/v1/conversations/{conversation_id}/messages" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "解釋 MCP 協議的詳細信息",
    "mentions": [{
      "configurationId": "your_agent_id_here",
      "context": {
        "時區": "Europe/Berlin",
        "模型設置": {"提供者": "anthropic"}
      }
    }],
    "context": {
      "時區": "Europe/Berlin"
    }
  }'

檢索消息

curl -X POST "http://localhost:5000/api/v1/conversations/{conversation_id}/messages" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "返回所有消息",
    "mentions": [{
      "configurationId": "your_agent_id_here",
      "context": {
        "時區": "Europe/Berlin",
        "模型設置": {"提供者": "anthropic"}
      }
    }]
  }'

📚 詳細文檔

配置

MCP Server 的配置通過 config.json 文件進行。該文件位於項目根目錄下。

示例配置

{
  "server": {
    "host": "0.0.0.0",
    "port": 5000,
    "debug": true
  },
  "api_key": "your_api_key_here",
  "workspace_id": "your_workspace_id_here"
}

環境變量

MCP Server 支持通過環境變量進行配置。以下是常用的環境變量：

• MCP_API_KEY：你的 API 密鑰
• MCP_WORKSPACE_ID：你的工作區 ID
• MCP_DEBUG：啟用調試模式（true 或 false）

命令行選項

MCP Server 提供以下命令行選項：

啟動服務器

python3 server.py --host HOST --port PORT [--debug]

參數

• --host: 服務器綁定的主機地址（默認：0.0.0.0）
• --port: 服務器監聽的端口（默認：5000）
• --debug: 啟用調試模式（默認：false）

日誌記錄

python3 server.py --log-file LOG_PATH [--log-level LEVEL]

參數

• LOG_PATH: 日誌文件的路徑
• LEVEL: 日誌級別（DEBUG, INFO, WARNING, ERROR, CRITICAL，默認：INFO）

🔧 技術細節

MCP Server 提供 RESTful API，允許客戶端與 MCP 服務進行交互。以下是可用的 API 端點及其詳細說明。

創建會話

POST /api/v1/conversations

描述

創建一個新的對話會話。

請求頭

• Authorization: Bearer Token（必填）
• Content-Type: application/json

請求體

{
  "title": "string", // 對話的標題（可選）
  "model": "string" // 使用的模型（必填）
}

響應

{
  "id": "string", // 新創建會話的 ID
  "title": "string",
  "created_at": "datetime"
}

發送消息

POST /api/v1/conversations/{conversation_id}/messages

描述

向指定對話會話發送一條新消息。

請求頭

• Authorization: Bearer Token（必填）
• Content-Type: application/json

請求體

{
  "content": "string", // 消息內容（必填）
  "mentions": array // 提到的用戶或角色（可選）
}

響應

{
  "id": "string",
  "content": "string",
  "sent_at": "datetime"
}

檢索消息

POST /api/v1/conversations/{conversation_id}/messages

描述

檢索指定對話會話中的所有消息。

請求頭

• Authorization: Bearer Token（必填）
• Content-Type: application/json

請求體

{
  "content": "string", // 查詢條件，如 "返回所有消息"（必填）
  "mentions": array // 提到的用戶或角色（可選）
}

響應

[
  {
    "id": "string",
    "content": "string",
    "sent_at": "datetime"
  },
  ...
]

📄 許可證

文檔中未提及許可證相關信息。

⚠️ 重要提示

• 確保 API 密鑰和工作區 ID 的安全性，避免洩露。
• 在生產環境中禁用調試模式。

💡 使用建議

在使用 MCP Server 時，建議先仔細閱讀配置和命令行選項的說明，根據實際需求進行靈活配置。同時，注意保護好 API 密鑰和工作區 ID，避免造成安全風險。