SousChef MCP 服务器
使用说明内容(Markdown格式)
-
项目简介 SousChef MCP 服务器是一个面向大语言模型的后端服务,负责提供可读写的资源、可注册与执行的工具,以及可渲染的提示模板,基于 MCP(Model Context Protocol)实现与 MCP 客户端的 JSON-RPC 通信,支持多传输协议以适应不同的集成场景。
-
主要功能点
- 资源管理与数据访问:托管、查询和持久化各种 Migration 相关的数据资源(Resources),为 LLM 客户端提供数据访问能力。
- 工具注册与执行:注册可调用的 Tools,允许 LLM 客户端通过 MCP 调用外部功能实现迁移/转换等任务。
- Prompt 模板定义与渲染:提供可定制的 Prompt 模板,便于在与模型的对话中渲染上下文信息和执行结果。
- 会话与能力声明:支持会话管理、能力声明,便于不同模型/客户端协同工作。
- 多传输协议支持:支持 Stdio、SSE、WebSocket 等传输方式,适配本地开发与远程部署场景。
- JSON-RPC 交互:客户端通过标准化的 JSON-RPC 请求进行资源读取、工具调用、Prompt 获取等操作,服务器返回 JSON-RPC 响应或通知。
-
安装步骤
- 环境准备:需要 Python3.10+,以及符合仓库依赖的运行环境。
- 安装与运行:根据项目提供的安装/运行方式将源码安装到运行环境中后启动 MCP 服务器。具体命令与依赖请参考仓库中的文档与配置示例。
- 依赖与测试:仓库自带完整测试用例,请使用 Poetry/Mypy/ Ruff 等工具执行测试以确保环境一致性。
-
服务器配置(给 MCP 客户端的连接配置 JSON 示例) 说明:MCP 客户端需要一个配置来知道如何启动并连接到 MCP 服务器。配置信息为 JSON,包含服务器名称、启动命令以及参数。以下信息基于仓库提供的实现要点生成,实际环境请按服务器部署方式微调。
- server_name:SousChef MCP Server
- command:python3
- args: ["-m", "souschef.server", "--host", "0.0.0.0", "--port", "8000", "--transport", "websocket"] 注释:上述启动参数用于在本地对外暴露一个 WebSocket 传输的 MCP 服务,客户端将通过该传输协议与 MCP 服务进行 JSON-RPC 通信。若实际部署支持多种传输,请将 transport 指定为需要的模式(如 websocket、stdio、sse 等),并在客户端配置中对应调整。
-
基本使用方法
- 启动服务:在服务器上以提供的启动命令启动 MCP 服务,确保网络可访问。
- 客户端对接:使用 MCP 客户端加载此服务器的配置,建立连接后即可通过 JSON-RPC 请求实现资源读取、工具调用、Prompts 获取等操作。
- 运行与调试:服务器端应暴露日志、错误信息以及能力声明等,便于排错与调优。
-
重要注意事项
- 该服务器实现设计目标是面向 MCP 客户端的上下文服务框架,实际部署中需要结合现有的认证、权限、日志与审计策略进行整合。
- 在生产环境中应结合安全传输(如 TLS/HTTPS、WebSocket 安全策略)以及对外暴露口的访问控制来保护敏感数据。