Sourcesync.ai

🚀 SourceSync.ai MCP 服務器指南（中文版）

本指南主要介紹了 SourceSync.ai MCP 服務器的安裝、配置、使用方法，以及故障排除和開發相關信息，幫助用戶快速上手並解決使用過程中遇到的問題。

🚀 快速開始

安裝依賴

在項目根目錄運行以下命令以安裝所需依賴：

npm install

啟動服務器

構建項目後，啟動服務器：

node dist/index.js

環境變量配置

創建一個 .env 文件並添加以下內容：

PORT=3001 # 服務運行的端口，默認為3001
DEBUG=false # 是否啟用調試日誌，默認為false

📦 安裝指南

創建新配置文件

在 src/config/ 目錄下創建一個新文件，例如 custom-config.ts：

export const config = {
  host: "localhost", // 服務綁定的主機地址，默認為所有接口
  port: 3001,        // 服務運行的端口，默認為3001
  namespace: "",     // 默認命名空間，留空則不使用
  logLevel: "info"   // 日誌級別：debug、info、warn、error，默認為info
};

安裝與啟動

npm install
node dist/index.js

✨ 主要特性

文檔管理工具

• getDocuments：獲取指定命名空間下的所有文檔。
• queryDocuments：根據查詢條件獲取匹配的文檔。
• addDocument：添加新的文檔到知識庫。
• updateDocument：更新現有文檔的內容。
• deleteDocument：刪除指定的文檔。

問題解答工具

• answerQuestion：基於知識庫內容回答問題。
• contextWindow：設置上下文窗口大小以控制信息檢索範圍。
• retrievalMode：切換不同的檢索模式（精確、模糊）。

💻 使用示例

基礎用法

文檔獲取工作流

1. 使用 getDocuments 並設置 includeConfig.parsedTextFileUrl: true 以獲取包含內容 URL 的文檔
2. 從響應中提取 URL
3. 使用 fetchUrlContent 拉取實際內容：

{
  "name": "fetchUrlContent",
  "arguments": {
    "url": "https://example.com"
  }
}

📚 詳細文檔

故障排除

連接問題

1. 驗證路徑：確保配置中的所有路徑都是絕對路徑，而非相對路徑。
2. 檢查權限：確保服務器文件有執行權限（chmod +x dist/index.js）。
3. 啟用開發者模式：在 Claude Desktop 中啟用開發者模式並查看 MCP 日誌文件。
4. 直接運行服務器：

node /path/to/sourcesyncai-mcp/dist/index.js

5. 重啟 AI 客戶端：在進行更改後，完全重啟 Claude Desktop 或 Cursor。
6. 檢查環境變量：確保所有必需的環境變量已正確設置。

調試日誌

為了詳細記錄，請添加 DEBUG 環境變量：

DEBUG=true

開發信息

項目結構

• src/index.ts：主入口文件和服務器配置
• src/schemas.ts：所有工具的方案定義
• src/sourcesync.ts：與 SourceSync.ai API 交互的客戶端
• src/sourcesync.types.ts：TypeScript 類型定義

構建與測試

# 構建項目
npm run build

# 運行測試
npm test

📄 許可證

MIT

🔗 鏈接

• SourceSync.ai 文檔
• SourceSync.ai API 參考
• 模型上下文協議