使用说明

项目简介: Dojo MCP Server 是一个使用 Go 语言开发的 Model Context Protocol (MCP) 服务器实现。它旨在为大型语言模型 (LLM) 应用提供一个标准化的后端服务,用于管理和提供上下文信息。Dojo MCP Server 允许您托管和管理各种资源(如文本文件),注册和执行工具(扩展 LLM 的能力),以及定义和渲染 Prompt 模板,从而灵活地控制 LLM 的交互方式。

主要功能点:

  • 资源管理: 可以加载和管理文本资源,并以标准化的方式提供给 MCP 客户端。
  • 工具注册与执行: 允许注册自定义工具,这些工具可以被 LLM 客户端调用以执行外部功能。内置 Prompt 工具,可以将 Prompt 模板注册为工具供调用。
  • Prompt 模板渲染: 支持定义和渲染 Prompt 模板,可以根据客户端请求动态生成 Prompt,实现定制化的 LLM 交互。
  • 多协议支持: 支持 SSE (Server-Sent Events) 和 Stdio (标准输入/输出) 两种传输协议,方便不同类型的 MCP 客户端连接。
  • 会话管理和能力声明: MCP 服务器负责管理会话,并向客户端声明自身的能力。

安装步骤:

  1. 安装 Go 语言环境: 确保您的机器上已安装 Go 语言环境 (>= 1.18)。您可以从 https://go.dev/dl/ 下载并安装。
  2. 克隆仓库: 使用 Git 克隆 Dojo MCP Server 仓库到本地:
    git clone https://github.com/Larkooo/dojo-mcp-go
    cd dojo-mcp-go
  3. 构建项目: 在仓库根目录下,使用 Go 命令构建项目:
    go build -o dojo-mcp-server main.go
    这将在当前目录下生成可执行文件 'dojo-mcp-server' (或 'dojo-mcp-server.exe' 在 Windows 上)。

服务器配置: MCP 客户端需要配置服务器的启动命令和参数才能连接到 Dojo MCP Server。以下是一个示例 JSON 配置,您可以将其提供给 MCP 客户端。请注意,此配置假设 'dojo-mcp-server' 可执行文件与客户端在同一目录下,并且使用 Stdio 协议连接。

{
  "serverName": "DojoMCP",
  "command": "./dojo-mcp-server",
  "args": [],
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,可以自定义。
  • 'command': 启动 MCP 服务器的可执行文件路径。如果 'dojo-mcp-server' 可执行文件在 PATH 环境变量中,可以直接写 'dojo-mcp-server'。否则,需要指定相对或绝对路径,例如 './dojo-mcp-server' 表示当前目录下的可执行文件。
  • 'args': 启动服务器时需要传递的命令行参数,本项目默认不需要额外的参数,所以为空数组 '[]'。
  • 'transport': 指定 MCP 客户端与服务器通信的传输协议。这里设置为 'stdio' 表示使用标准输入/输出进行通信。也可以使用 'sse' 如果客户端支持 SSE 协议,服务器启动时会自动同时支持 SSE 和 Stdio。

基本使用方法:

  1. 启动服务器: 在终端中运行构建生成的可执行文件 'dojo-mcp-server':

    ./dojo-mcp-server

    服务器启动后,您应该看到类似 "Starting Dojo MCP server" 和 "Starting SSE server" 的日志信息。

  2. 配置 MCP 客户端: 根据您的 MCP 客户端软件的指引,配置连接到 Dojo MCP Server。通常需要提供上面生成的 JSON 配置信息。

  3. 使用 MCP 客户端与服务器交互: 一旦客户端成功连接到服务器,您就可以使用客户端的功能,例如:

    • 读取资源: 客户端可以请求读取服务器上托管的文本资源。
    • 调用工具: 客户端可以调用服务器上注册的工具,例如 Prompt 工具,并传递参数。
    • 获取 Prompt: 客户端可以请求服务器渲染并返回 Prompt 模板。

具体的操作方式取决于您使用的 MCP 客户端软件。请参考您使用的客户端软件的使用文档。

信息

分类

AI与计算