Scrapbox Cosense MCP

🚀 Scrapbox 和 Cosense 的 MCP 服務器文檔

本項目提供了 Scrapbox 和 Cosense 的 MCP 服務器相關功能，可對條目進行獲取、創建、更新、刪除和搜索等操作，同時介紹了環境配置、API 請求格式、部署使用等內容。

🚀 快速開始

本服務器可實現對 Scrapbox 和 Cosense 條目的多種操作，如獲取、創建、更新、刪除和搜索等。使用前需進行環境變量配置和依賴安裝。

✨ 主要特性

get 操作

• 獲取單個條目：可通過指定條目的唯一標識符來檢索特定條目的內容。
• 獲取所有條目：能檢索存儲在 Scrapbox 中的所有條目。

post 操作

• 創建新條目：用戶可向服務器發送新的條目數據，包括標題和可選的內容文本，並獲得該條目的唯一標識符。
• 更新現有條目：支持通過指定條目的唯一標識符來更新其內容。
• 刪除特定條目：可通過指定條目的唯一標識符來刪除特定的條目。

search 操作

• 基本搜索：支持基於標題或內容的關鍵字搜索，返回匹配的所有條目的唯一標識符。
• 高級搜索：支持通過邏輯運算符（如 AND、OR、NOT）組合多個關鍵字進行復雜查詢，進一步縮小結果範圍。

📦 安裝指南

安裝依賴項

運行以下命令安裝所需的 npm 包：

npm install

構建服務器

構建生產環境版本的服務器：

npm run build

開發模式下的自動重載

在開發過程中，可以啟用自動重載功能以提高效率：

npm run watch

💻 使用示例

基礎用法

獲取單個條目

{
  "operation": "get",
  "id": "string"
}

示例請求：

{
  "operation": "get",
  "id": "12345"
}

創建新條目

{
  "operation": "post",
  "title": "string",
  "content": "string (optional)"
}

示例請求：

{
  "operation": "post",
  "title": "我的新筆記",
  "content": "今天是個好天氣。"
}

更新現有條目

{
  "operation": "update",
  "id": "string",
  "new_title": "string (optional)",
  "new_content": "string (optional)"
}

示例請求：

{
  "operation": "update",
  "id": "12345",
  "new_title": "更新後的筆記標題"
}

刪除特定條目

{
  "operation": "delete",
  "id": "string"
}

示例請求：

{
  "operation": "delete",
  "id": "12345"
}

搜索條目

{
  "operation": "search",
  "query": "string",
  "logic": "basic" 或 "advanced"
}

示例請求：

{
  "operation": "search",
  "query": "筆記 AND 天氣",
  "logic": "advanced"
}

📚 詳細文檔

環境變量配置

為了確保服務器的正常運行，需要在運行時設置以下環境變量：

API 請求格式

所有 API 請求均採用 JSON 格式，具體請求示例見“使用示例”部分。

響應格式

服務器返回的響應統一採用 JSON 格式：

成功操作

{
  "status": "success",
  "data": {
    // 具體數據根據操作類型而定
  }
}

失敗操作

{
  "status": "error",
  "message": "string" // 錯誤信息描述
}

Claude Desktop 配置

要在 Claude Desktop 中使用此 MCP 服務器，請按照以下步驟配置：

1. 打開 Claude 的設置文件：
   • MacOS：~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows：%APPDATA%/Claude/claude_desktop_config.json
2. 添加以下配置到 mcpServers 對象中：

{
  "mcp_servers": {
    "scrapbox_cosense_server": {
      "type": "custom",
      "uri": "http://localhost:3000", // 根據實際情況修改地址和端口
      "env_vars": {
        "COSENSE_PROJECT_NAME": "my_project",
        "COSENSE_SID": "abc123-def456-ghi789"
      }
    }
  }
}

🔧 技術細節

本服務器基於相關技術實現了對 Scrapbox 和 Cosense 條目的各種操作。通過設置環境變量進行項目和身份驗證配置，使用 JSON 格式進行 API 請求和響應。在部署方面，使用 npm 進行依賴安裝和服務器構建，同時支持開發模式下的自動重載。在 Claude Desktop 中使用時，需在配置文件中添加相應的服務器配置。

📄 故障排除

常見問題

1. 無法連接到服務器
   • 確保服務器正在運行。
   • 檢查網絡連接，確保沒有防火牆阻止通信。
2. 認證失敗
   • 核對 COSENSE_SID 是否正確。
   • 確保 COSENSE_PROJECT_NAME 與目標項目名稱一致。
3. 搜索功能不正常
   • 確認邏輯運算符的使用是否符合預期。
   • 檢查關鍵字拼寫，避免因大小寫或符號錯誤導致匹配失敗。

聯繫支持

如果遇到無法解決的問題，請聯繫我們的技術支持團隊：

• 郵箱：support@scrapbox.com
• 電話：+86-123-456789