Synapse MCP

Synapse MCP服务器是一个提供RESTful API的服务，用于通过模型上下文协议(MCP)访问Synapse实体及其注释，支持OAuth2认证。

研究与数据开发者工具 #数据访问 #REST API #OAuth2认证 #实体管理 .Python

评分 : 2.5分

下载量 : 9.7K

更新时间 : 2025-04-28

打开站点

什么是Synapse MCP Server?

Synapse MCP Server是一个中间件服务，它通过标准化的Model Context Protocol(MCP)协议，让用户能够以简单的方式访问和管理Synapse平台上的各类数据实体。无论您是研究人员还是数据分析师，都可以通过这个服务轻松获取项目、数据集、文件等资源及其元数据。

如何使用Synapse MCP Server?

您可以通过简单的HTTP请求或与Claude等AI工具集成来使用本服务。首先需要安装服务并配置认证，然后就可以通过REST API访问Synapse数据。服务支持两种认证方式：API密钥和OAuth2。

适用场景

本服务特别适合以下场景： - 需要以编程方式访问Synapse数据的应用开发 - 将Synapse数据集成到AI助手(如Claude)的工作流中 - 批量获取和管理多个Synapse实体的元数据 - 构建数据目录或元数据管理系统

主要功能

实体访问

通过ID或名称获取Synapse实体(数据集、项目、文件夹、文件、表格)的详细信息

注释管理

获取和查询实体的注释信息(元数据)

灵活查询

支持多种查询方式：按类型、父实体、名称或自定义条件查询实体

表格查询

使用SQL-like语法查询Synapse表格数据

安全认证

支持OAuth2和API密钥两种认证方式，保障数据安全

Croissant格式

支持以Croissant元数据格式获取数据集信息

优势

标准化接口：通过RESTful API提供一致的数据访问方式

多种认证选择：支持API密钥和OAuth2两种认证方式

灵活查询：提供多种查询方式满足不同需求

易于集成：可与Claude等AI工具无缝集成

跨平台：支持Docker部署，可在多种环境中运行

局限性

需要Synapse账号：使用前必须先拥有有效的Synapse账号

性能限制：大量数据查询时可能有性能瓶颈

学习曲线：非技术人员可能需要时间熟悉API使用

如何使用

安装服务

通过pip安装或从源代码构建服务

启动服务器

运行服务并指定主机和端口

认证配置

选择API密钥或OAuth2方式进行认证

开始使用API

通过HTTP请求访问各种API端点获取数据

使用案例

获取研究项目元数据

研究人员需要获取某个项目的详细信息和所有相关文件的元数据

数据集目录构建

数据管理员需要构建所有数据集的目录，包括Croissant格式的元数据

表格数据分析

分析师需要查询Synapse表格中的数据进行分析

常见问题

如何获取Synapse API密钥?

服务支持哪些实体类型?

如何部署到生产环境?

查询结果有数量限制吗?

如何与Claude集成?

🚀 Synapse MCP 服务器指南

本指南将详细介绍 Synapse MCP 服务器的安装、配置、使用、部署等内容，帮助你快速上手并使用该服务器。

🚀 快速开始

安装与配置

克隆仓库并安装依赖

打开终端，运行以下命令克隆仓库：

git clone https://github.com/susheel/synapse-mcp.git
cd synapse-mcp

创建虚拟环境并激活：
- Linux/Mac：

python -m venv .venv
source .venv/bin/activate

- **Windows**：

python -m venv .venv
.\.venv\Scripts\activate

安装依赖：

pip install -e .

配置Claude Desktop

打开Claude Desktop，点击菜单栏的“Claude” -> “Settings...”
在左侧选择“Developer”，然后点击“Edit Config”
添加以下配置到 mcpServers 节点：

"synapse-mcp": {
  "command": "python",
  "args": [
    "/path/to/synapse-mcp/server.py",
    "--host", "127.0.0.1",
    "--port", "9000"
  ]
}

保存配置文件并重启Claude Desktop

💻 使用示例

基础用法

获取实体信息

示例查询：Get the entity with ID syn123456 from Synapse

查询项目数据

示例查询：Query all files in the Synapse project syn123456

获取注释信息

示例查询：Get annotations for the Synapse entity syn123456

📦 安装指南

Docker部署

构建镜像

docker build -t synapse-mcp .

运行容器

# 使用OAuth配置运行
docker run -p 9000:9000 -e SYNAPSE_OAUTH_CLIENT_ID=your_client_id -e SYNAPSE_OAUTH_CLIENT_SECRET=your_client_secret -e SYNAPSE_OAUTH_REDIRECT_URI=your_redirect_uri synapse-mcp

# 使用SSE模式运行
docker run -p 9000:9000 -e MCP_TRANSPORT=sse -e MCP_SERVER_URL=mcp://your-domain:9000 synapse-mcp

Fly.io部署

安装并配置flyctl

curl -L https://fly.io/install.sh | sh
flyctl auth login

发布应用

flyctl launch

设置密钥

flyctl secrets set SYNAPSE_OAUTH_CLIENT_ID=your_client_id
flyctl secrets set SYNAPSE_OAUTH_CLIENT_SECRET=your_client_secret
flyctl secrets set SYNAPSE_OAUTH_REDIRECT_URI=https://your-app-name.fly.dev/oauth/callback
flyctl secrets set MCP_TRANSPORT=sse
flyctl secrets set MCP_SERVER_URL=mcp://your-app-name.fly.dev:9000