Contributing

We are committed to fostering a safe and inclusive open-source community.
Please review and follow our Code of Conduct when contributing or participating in this project.

Prerequisites

• Node.js >= 20.19 or nvm
• Claude Desktop (with MCP support)
• Bun latest runtime

Bun Setup

Install Bun by following the official instructions: Bun Installation Guide

Or use the one-line installer:

$ curl -fsSL https://bun.com/install | bash

To check that Bun was installed successfully, open a new terminal window and run:

$ bun -version

Clone the repository

git clone https://github.com/binspireai/mcp.git
cd mcp

Install Dependencies

$ bun install

Setup .env (environment variables)

Copy the example file to .env:

$ cp env.example .env

Development Server

Run the development servers with STDIO.

$ bun run dev:stdio

Run the development servers with HTTP.

$ bun run dev:http

Production Server

Run the production servers with STDIO.

$ bun run start:stdio

Run the production servers with HTTP.

$ bun run start:http

Running Build

$ bun run build

Claude Desktop Configuration

Using STDIO transport:

{
  "mcpServers": {
    "binspire": {
      "command": "node",
      "args": ["/path/to/binspire-mcp/dist/index.js"],
      "env": {
        "TRANSPORT": "stdio",
        "DATABASE_URL": "your_database_url_here"
      }
    }
  }
}

Using HTTP transport:

{
  "mcpServers": {
    "binspire": {
      "url": "http://localhost:3000",
      "env": {
        "DATABASE_URL": "your_database_url_here"
      }
    }
  }
}

Contributor List

Code of Conduct

We are committed to fostering a welcoming, respectful community. Please read and follow our Code of Conduct when participating in this project.

Security

If you believe you have found a security vulnerability in Binspire MCP, please do not open a public issue on this repository. Opening a public issue could expose sensitive information before it's addressed. Please read our Security Policy for details on how to report a vulnerability.

License

Binspire MCP is licensed under GPL-3.0.