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 参考
• 模型上下文协议