MCPixy 🚀

MCPixy 是一个零配置的 MCP（模型上下文协议）服务器构建器，适用于开发或本地工作，允许您仅通过 YAML 配置创建 MCP 服务器。几分钟内连接任何工具到您的大语言模型，无需编写代码。

✨ 特性

🔧 三种简单的工具类型

• CLI 工具 ⚙️ - 执行命令，运行脚本，访问系统工具
• HTTP 工具 🌐 - 发起 API 调用，处理身份验证，管理网络请求
• 网页抓取 🕷️ - 使用 CSS 选择器从网站中提取数据

🛡️ 安全与信任

• 数字签名 - 对工具进行签名和验证以确保安全性
• 身份验证 - 基于 JWT 的身份验证，具有可配置模式
• 审计日志 - 跟踪所有工具的使用和访问情况
• 可信密钥 - 管理已验证工具的公钥

🚀 零配置

• 引导设置 - 通过一条命令开始
• YAML 配置 - 定义工具而无需编码
• 自动发现 - 自动加载目录中的工具

🚀 快速入门

先决条件

• Rust 1.70+ (安装 Rust)
• Git

安装

# 克隆仓库
git clone https://github.com/jondot/mcpixy.git
cd mcpgw

# 构建项目
cargo build --release

# 使用默认配置引导
mcpixy bootstrap

引导过程会创建默认配置、一个示例工具文件以及用于签署工具的密钥对，在 ~/.mcpixy 目录下。

下次运行 mcpixy 时，它会自动加载这些配置。

第一个工具

编辑在 ~/.mcpixy/tools/sample_tools.yaml 中引导的工具，并添加如下内容：

tools:
  - id: http_get_example
    type: http
    name: "HTTP GET 示例"
    description: "向任意 URL 发送简单 GET 请求"
    method: GET
    url: "{{input.url}}"
    headers:
      User-Agent: "MCPixy/1.0"
    input_schema:
      type: object
      properties:
        url:
          type: string
          description: "要发送 GET 请求的 URL"
      required: [url]

签署此工具：

mcpixy sign-tool --file ~/.mcpixy/tools/sample_tools.yaml --tool-id http_get_example

或者签署所有工具：

mcpixy sign-tool --file ~/.mcpixy/tools/sample_tools.yaml

配置 Cursor IDE

在您的 mcp.json 文件中添加以下条目：

{
  "mcpServers": {
    "mcpixy": {
      "url": "http://localhost:3033/mcp"
    }
  }
}

如果您正常运行了 mcpixy，这将只提供 已签名的工具，要允许未签名的工具运行，请使用 mcpixy --allow-unsigned。

要使用 JWT 身份验证，请配置 gateway.toml：

[auth]
mode = "jwt"
algorithm = "HS256"                   # 或 "RS256"
secret = "your-super-secret-key-here" # 对于 HS256

使用密钥签署 JWT，并通过您的 mcp.json 配置提供它：

{
  "mcpServers": {
    "mcpixy": {
      "url": "http://localhost:3033/mcp",
      "headers": {
        "Authorization": "Bearer eyJ...<TOKEN剩余部分>"
      }
    }
  }
}

🛠️ CLI 命令

核心命令

# 使用默认配置引导
mcpixy bootstrap

# 为安全目的签署工具
mcpixy sign-tool --file tools.yaml --tool-id my_tool

# 验证工具签名
mcpixy verify-tool --file tools.yaml --tool-id my_tool

服务器选项

# 使用自定义配置启动
mcpixy --config my_config.toml

# 覆盖端口
mcpixy --port 8080

# 设置日志级别
mcpixy --log-level debug

# 检查配置
mcpixy --check-config

🔐 安全特性

数字签名

• Ed25519 密钥对用于工具验证
• 公钥管理 用于可信来源
• 签名验证 在执行工具之前

身份验证模式

• 无 - 无身份验证
• JWT - JSON Web Token 身份验证

审计日志

• 全面的日志记录 所有工具执行
• 用户跟踪 和访问监控
• 性能指标 和错误报告

🌐 测试 UI

在启动网关后，通过 http://<您的 mcpixy 地址>/ui 访问 Web UI：

• 工具管理 - 查看、编辑和配置工具
• 实时监控 - 实时观看工具执行
• 配置编辑器 - 视觉 YAML 编辑
• 使用分析 - 性能和使用洞察

🤝 贡献

我们欢迎贡献！请参阅我们的贡献指南：

1. 分叉仓库
2. 创建功能分支
3. 进行更改
4. 如适用，添加测试
5. 提交拉取请求

📄 许可证

本项目根据 MIT 许可证发布 - 详情见 LICENSE 文件。