使用说明
项目简介
'mcp-clojure-sdk' 是一个 Clojure 语言的软件开发工具包 (SDK),旨在帮助开发者快速构建基于 Model Context Protocol (MCP) 的服务器。它基于 'lsp4clj' 库,简化了 JSON-RPC 协议的处理,并提供了构建 MCP 服务器所需的核心组件。
主要功能点
- 提供用于创建 MCP 服务器的 SDK。
- 包含资源 (Resources)、工具 (Tools) 和 Prompt 模板 (Prompts) 的管理框架。
- 基于 JSON-RPC 协议与客户端通信。
- 提供示例服务器代码 (calculator_server.clj, vegalite_server.clj) 供参考。
安装步骤
- 这是一个 Clojure 项目,需要安装 Clojure 开发环境 (如 Leiningen 或 deps.edn 工具)。
- 从 GitHub 克隆仓库:
git clone https://github.com/unravel-team/mcp-clojure-sdk.git - 使用 'deps' 或 'lein' 进行依赖管理和项目构建。 具体参考 'examples/README.md' 中的说明。
服务器配置
MCP 客户端需要配置连接到 MCP 服务器的信息。对于使用 'calculator_server.clj' 示例服务器的情况,配置信息可能如下(请根据实际示例调整):
{ "serverName": "Calculator Server", "command": "clojure", "args": [ "-M", "-m", "calculator-server" ] }
参数注释:
- 'serverName': 服务器的名称,可以自定义,用于在客户端中识别服务器。
- 'command': 启动服务器的命令,通常为 'clojure' 解释器。
- 'args': 传递给 'clojure' 命令的参数列表,用于指定如何运行服务器代码:
- '-M': 使用 'deps.edn' 进行依赖管理,适用于基于 'deps.edn' 的 Clojure 项目。
- '-m': 运行指定的 Clojure 模块或命名空间作为应用程序的入口点。
- '"calculator-server"': 示例服务器的模块名或命名空间,请根据 'examples/src/calculator_server.clj' 文件中的 'ns' 定义进行调整。如果命名空间是 'examples.src.calculator-server',则此处应为 '"examples.src.calculator-server"'。
基本使用方法
- 启动 MCP 服务器 (例如,根据 'examples/README.md' 中的指示,使用 'clojure -M -m calculator-server' 命令启动 'calculator_server.clj' 示例服务器)。
- 在 MCP 客户端中,配置服务器连接信息,填入上述 JSON 配置。
- 客户端启动后,将自动尝试连接到 MCP 服务器。连接成功后,客户端即可通过 JSON-RPC 协议与服务器通信,例如列出服务器提供的资源、调用工具或获取 Prompt 模板。 具体 MCP 协议的使用方式请参考 MCP 官方文档和客户端软件的使用说明。
信息
分类
开发者工具