pyxel-mcp

使用说明（Markdown 摘要）

• 项目简介
  • 本仓库实现了一个 MCP 服务器，用于向大语言模型客户端提供 Pyxel 项目的资源访问、工具调用以及提示模板渲染等能力，目标是构建一个可扩展的后端上下文服务。
• 主要功能点
  • 资源、工具、提示模板的托管与管理，允许 LLM 客户端读取资源、注册和执行工具、获取并渲染 Prompt 模板。
  • 通过 JSON-RPC 与客户端通信，支持请求响应以及通知机制。
  • 服务器端负载会话管理、能力声明，具备多种传输协议的基础支持（例如 Stdio、SSE、WebSocket 的理念实现思路）。
  • 提供多种工具，涵盖从运行 Pyxel 脚本并截图、分析像素、读取图片银行、渲染音频等场景，便于 AI 容器进行自我验证、迭代和调试。
• 安装与运行
  • 运行前需具备 Python 环境，以及与 MCP 运行相关的依赖。
  • 启动命令（示例，实际请参考仓库实现细节）：
    • python -m pyxel_mcp.server
• 服务器配置（MCP 客户端配置示例，客户端无需本仓库的实现细节）
  • 该服务器对外暴露 MCP 功能，客户端需要的最小连接信息包括服务器名称、启动命令及参数，用于在客户端注册并通过 MCP 通道连接服务器。配置示例如下（仅为客户端使用的启动信息，与服务器内部实现无关）： { "serverName": "pyxel-mcp", "command": "python", "args": ["-m", "pyxel_mcp.server"] } 注解：
  • serverName 为 MCP 服务端的唯一标识，客户端将据此建立连接并进行请求/响应。
  • command 为启动服务器的命令，args 为启动参数（如入口模块和工作目录等信息，确保从仓库根路径正确启动服务器）。
  • 该配置仅用于 MCP 客户端连接服务器的启动阶段，实际的请求/响应、能力声明等逻辑由服务器实现完成。
• 基本使用方法
  • 启动服务器后，MCP 客户端即可通过 JSON-RPC 的方式向服务器发起对资源、工具和提示模板的查询与执行请求。
  • 客户端可以基于服务器提供的工具（如 run_and_capture、pyxel_info、render_audio、inspect_sprite 等）进行多模态分析、测试和验证工作流。
  • 如需本地调试，确保 Python 环境中已安装所需依赖，且 Pyxel 能在目标脚本中正常工作。