Serial Hardware Bridge

🚀 MCP2TCP Server Documentation

MCP2TCP server is a tool that can convert MCP protocol to TCP protocol, facilitating communication between MCP clients and servers.

🚀 Quick Start

The MCP2TCP server is a tool that converts the MCP protocol to the TCP protocol, enabling seamless communication between MCP clients and servers.

📦 Installation

Installation Steps

1. Clone the repository:

git clone https://github.com/your-username/mcp2tcp.git
cd mcp2tcp

2. Create and activate a virtual environment (Python 3.8+ is recommended):

python -m venv venv
source venv/bin/activate  # Use `venv\Scripts\activate` on Windows

3. Install the dependencies:

pip install -r requirements.txt

4. Configuration file locations:

• Current directory (suitable for development and testing): ./config.yaml
• User's home directory (recommended for personal use): C:\Users\<Username>\.mcp2tcp\config.yaml or /home/<Username>/.mcp2tcp/config.yaml
• System-level configuration (suitable for multi-user environments): C:\ProgramData\mcp2tcp\config.yaml or /etc/mcp2tcp/config.yaml

📚 Documentation

Server Configuration

Edit the config.yaml file:

server:
  host: "0.0.0.0"  # Listening address
  port: 8080        # Listening port
  loopback_only: false  # Whether to use only the loopback interface

MCP Client Configuration

In an MCP protocol-compatible client (such as Claude Desktop or Cline), add the following content:

{
    "mcpServers": {
        "mcp2tcp": {
            "command": "uv",
            "args": [
                "--directory",
                "Your actual path/mcp2tcp",  // Example: "C:/Users/Administrator/Documents/develop/my-mcp-server/mcp2tcp"
                "run",
                "mcp2tcp"
            ]
        }
    }
}

Specify the Parameter File Name

{
    "mcpServers": {
        "mcp2tcp": {
            "command": "uv",
            "args": [
                "--directory",
                "Your actual path/mcp2tcp",  // Example: "C:/Users/Administrator/Documents/develop/my-mcp-server/mcp2tcp"
                "run",
                "mcp2tcp",
                "--config",  // Optional parameter, specify the configuration file name
                "Pico"      // Optional parameter, specify the configuration file name, no need to add the `.yaml` suffix
            ]
        }
    }
}

💻 Usage Examples

Basic Usage

1. Activate the virtual environment:

source venv/bin/activate  # Use `venv\Scripts\activate` on Windows

2. Run the server (using default configuration):

uv run src/mcp2tcp/server.py
# Or
uv run mcp2tcp

Advanced Usage

Run the server with a specified configuration file:

uv run --config config.yaml

📄 Other Instructions

• Project repository address: https://github.com/your-username/mcp2tcp
• Issue feedback: Please submit issues or suggestions via Issues.

Thank you for using the MCP2TCP server! If you have any questions, please feel free to refer to the documentation or contact the support team.