Serial Hardware Bridge

🚀 MCP2TCP 服务器文档

MCP2TCP 服务器是一个将 MCP 协议相关功能进行处理并提供服务的工具。它可以帮助用户将 MCP 协议在 TCP 层面进行交互，方便在不同环境下使用。

🚀 快速开始

要快速使用 MCP2TCP 服务器，你需要按照以下步骤进行安装和配置。

📦 安装指南

安装步骤

1. 克隆仓库：

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

2. 创建并激活虚拟环境（推荐使用 Python 3.8+）：

python -m venv venv
source venv/bin/activate  # 在 Windows 上使用 `venv\Scripts\activate`

3. 安装依赖项：

pip install -r requirements.txt

4. 配置文件位置：

• 当前目录（适合开发测试）：./config.yaml
• 用户主目录（推荐个人使用）：C:\Users\<用户名>\.mcp2tcp\config.yaml 或 /home/<用户名>/.mcp2tcp/config.yaml
• 系统级配置（适合多用户环境）：C:\ProgramData\mcp2tcp\config.yaml 或 /etc/mcp2tcp/config.yaml

📚 详细文档

配置说明

服务器配置

编辑 config.yaml 文件：

server:
  host: "0.0.0.0"  # 监听地址
  port: 8080        # 监听端口
  loopback_only: false  # 是否仅使用环回接口

MCP 客户端配置

在支持 MCP 协议的客户端（如 Claude Desktop 或 Cline）中，添加以下内容：

{
    "mcpServers": {
        "mcp2tcp": {
            "command": "uv",
            "args": [
                "--directory",
                "你的实际路径/mcp2tcp",  // 示例: "C:/Users/Administrator/Documents/develop/my-mcp-server/mcp2tcp"
                "run",
                "mcp2tcp"
            ]
        }
    }
}

指定参数文件名

{
    "mcpServers": {
        "mcp2tcp": {
            "command": "uv",
            "args": [
                "--directory",
                "你的实际路径/mcp2tcp",  // 示例: "C:/Users/Administrator/Documents/develop/my-mcp-server/mcp2tcp"
                "run",
                "mcp2tcp",
                "--config",  // 可选参数，指定配置文件名
                "Pico"      // 可选参数，指定配置文件名，不需要添加 `.yaml` 后缀
            ]
        }
    }
}

运行服务器

1. 激活虚拟环境：

source venv/bin/activate  # 在 Windows 上使用 `venv\Scripts\activate`

2. 运行服务器（使用默认配置）：

uv run src/mcp2tcp/server.py
# 或者
uv run mcp2tcp

3. 使用指定配置文件运行：

uv run --config config.yaml

其他说明

• 项目仓库地址：https://github.com/your-username/mcp2tcp
• 问题反馈：请通过 Issues 提交问题或建议。

感谢使用 MCP2TCP 服务器！如果有任何疑问，请随时查阅文档或联系支持团队。