使用说明(Markdown 格式)

  • 项目简介
    • 该项目实现一个 MCP 服务器,用于对接外部 AI 助手(如 Claude Desktop 等)并通过 MCP 协议提供资源、工具、以及提示渲染能力,便于在 LLM 客户端中以标准化方式访问 EDAMAME Posture 的安全上下文与自动化能力。
  • 主要功能点
    • MCP 服务器核心能力:实现 MCP 请求/响应的处理,提供服务器端会话管理与能力声明,支持多种传输模式(如本地、网络访问等)。
    • 资源、工具与提示管理:托管与暴露 Resources、Tools 与 Prompts,允许外部 AI 客户端对齐、查询和调用。
    • JSON-RPC 通信:服务器端按 MCP 规定接收客户端请求并返回标准化的 JSON-RPC 响应与通知。
    • 安全与部署:通过 PSK 认证、端口绑定控制、以及对外接口的安全配置,支持本地回环或全网暴露的部署模式。
    • 与 EDAMAME Posture 生态协同:MCP 服务端与 EDAMAME Core/CLI 的其他组件协同工作,提供统一的安全上下文与自动化工具链。
  • 安装步骤(简明)
    • 获取代码:从仓库获取源码,确保环境具备 Rust 构建与所依赖的本地系统环境。
    • 构建与打包:使用项目提供的构建脚本/命令进行编译,确保 MCP 相关模块已编译到可执行文件中。
    • 运行 MCP 服务器:启动 MCP 服务,通常通过 edamame_posture 的相关命令来启动,若采用自带安装方式则直接执行相应 MCP 子命令。
    • 生成/获取 PSK:在首次对外暴露的 MCP 服务时,按流程生成或配置一个 32 字符的 PSK,客户端需使用该 PSK 进行认证。
    • 连接客户端:客户端通过 MCP 配置(含服务器地址、端口、PSK 等信息)建立连接,并可通过 JSON-RPC 调用服务器暴露的工具、资源及 Prompts。
  • 服务器配置(JSON 说明) 该配置用于 MCP 客户端了解如何连接与对接 MCP 服务器的启动信息。字段说明如下(配置信息以 JSON 字符串形式存在,示例以描述性质呈现):
    • server_name(服务器名称): edamame_mcp_server
    • command(启动服务器的命令): edamame_posture
    • args(命令参数数组): 包含 MCP 启动所需的参数集合,例如 ["background-mcp-start", "<端口>", "<PSK>", "--all-interfaces"] 注释说明:
    • 端口:默认 3000,如需远程访问请设置为合适的端口并确保防火墙放通。
    • PSK:32 字符长度的预共享密钥,由 mcp-generate-psk 获取,客户端需要将其放入授权头中进行认证。
    • all-interfaces:如需让 MCP 服务器监听所有网络接口,请加入该参数(默认为本地回环地址)。
    • client_args:客户端连接时可附带的额外参数,用于区分连接来源、用途或安全策略等。
  • 基本使用方法
    • 启动 MCP 服务器后,客户端可通过如下流程连接并使用:
      1. 生成 PSK(如尚未生成):使用 mcp-generate-psk 自动生成一个 32 字符的密钥。
      2. 以服务器启动命令及参数启动 MCP 服务端,服务器地址通常为 http://<主机IP>:<端口>/mcp。
      3. 在 Claude Desktop 等客户端中配置 MCP 服务器,提供服务器 URL 和 Authorization: Bearer <PSK> 的认证信息,即可开始对 EDAMAME 的工具、资源和 Prompts 进行查询与操作。
    • 常用操作包括:获取工具列表、执行工具、获取资源、渲染与获取 Prompt 模板、以及通过 MCP 进行基本对话与协作。

信息

分类

开发者工具