Spacebridge MCP

🚀 SpaceBridge-MCP Server English Guide

This guide provides a comprehensive introduction to the installation, operation, and configuration of the SpaceBridge-MCP server, as well as usage tips, development guidance, and contribution guidelines.

📦 Installation

Method 1: Install from Source Code

1. Clone the project repository:

   git clone git@github.com:your-repository.git
   cd spacebridge-mcp
   

2. Create and activate a virtual environment (recommended):

   python -m venv .venv
   source .venv/bin/activate  # On macOS/Linux
   .\.venv\Scripts\activate    # On Windows
   

3. Install dependencies:

   pip install -r requirements.txt
   

Method 2: Direct Installation

pip install spacebridge-mcp

🚀 Server Operation

Start the server:

spacebridge-mcp-server

By default, the server will listen for MCP connections via standard input and output (stdio).

💻 Client Connection Configuration

Configuration Steps:

1. Installation: Ensure that spacebridge-mcp is correctly installed.
2. Find the Server Path:
   • If installed in a virtual environment, the path might be /path/to/your/project/.venv/bin/spacebridge-mcp-server.
   • If installed globally, you can use the command which spacebridge-mcp-server (macOS/Linux) or where spacebridge-mcp-server (Windows) to find it.
3. Add to the Client: Add a new server in the MCP client.

Example: Using Claude code

claude mcp add spacebridge \
  /full/path/to/your/spacebridge-mcp-server \
  --scope user \
  --env SPACEBRIDGE_API_URL="https://your-spacebridge.com/api" \
  --env SPACEBRIDGE_API_KEY="your-spacebridge-api-key" \
  --env OPENAI_API_KEY="your-openai-api-key" \
  --env SPACEBRIDGE_ORG_NAME="your-explicit-org" \      # If required
  --env SPACEBRIDGE_PROJECT_NAME="your-explicit-project" # If required

• --scope user indicates that the server is available for all projects; --scope project restricts it to the current project.

Other Clients (e.g., Windsurf, Cursor)

Please refer to the documentation of the specific client and ensure that the following environment variables are passed:

• SPACEBRIDGE_API_URL
• SPACEBRIDGE_API_KEY
• OPENAI_API_KEY
• And optionally SPACEBRIDGE_ORG_NAME and SPACEBRIDGE_PROJECT_NAME

💡 Usage Tips and Automated Workflows

Automated Commit Messages

Configure AI tools (e.g., Claude code, Windsurf, Cursor) to automatically reference relevant issue IDs when generating commit messages.

Example Rule/Instruction:

• "When generating commit messages, always ask the SpaceBridge-MCP tool to find or create an issue related to the changes and reference its ID."

Quick Access

Use the following command to quickly start the server:

python -m spacebridge_mcp.main

🛠️ Development Guide

Environment Setup

1. Clone the project repository.
2. Create and activate a virtual environment (recommended).

Enable Debug Mode

Enable debugging functionality in the development environment:

SPACEBRIDGE_DEBUG=1 spacebridge-mcp-server

🤝 Contribution Guide

1. Before submitting code, ensure that all test cases pass.
2. Follow the Contribution Guidelines.

🐞 Issue Feedback

If you encounter any issues or need assistance, please contact us:

• Email: support@spacebridge.com
• GitHub: Issues Page

Thank you for using the SpaceBridge-MCP Server!