Synapse MCP

🚀 Synapse MCP Server Guide

This guide provides a comprehensive overview of the Synapse MCP server, including installation, configuration, usage examples, deployment, contribution guidelines, and licensing information.

🚀 Quick Start

📦 Installation and Configuration

Clone the Repository and Install Dependencies

1. Open your terminal and run the following commands to clone the repository:

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

2. Create and activate a virtual environment:

   • Linux/Mac:

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

   • Windows:

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

3. Install the dependencies:

pip install -e .

Configure Claude Desktop

1. Open Claude Desktop and click on "Claude" -> "Settings..." in the menu bar.
2. Select "Developer" on the left side, then click "Edit Config".
3. Add the following configuration to the mcpServers node:

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

4. Save the configuration file and restart Claude Desktop.

💻 Usage Examples

Get Entity Information

• Example query: Get the entity with ID syn123456 from Synapse

Query Project Data

• Example query: Query all files in the Synapse project syn123456

Get Annotation Information

• Example query: Get annotations for the Synapse entity syn123456

🚀 Deployment Guide

Docker Deployment

Build the Image

docker build -t synapse-mcp .

Run the Container

# Run with OAuth configuration
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

# Run in SSE mode
docker run -p 9000:9000 -e MCP_TRANSPORT=sse -e MCP_SERVER_URL=mcp://your-domain:9000 synapse-mcp

Fly.io Deployment

Install and Configure flyctl

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

Publish the Application

flyctl launch

Set Secrets

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

Deploy

flyctl deploy

👥 Contribution Guidelines

Contributions are welcome! Feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License.