项目简介

Agent8 MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,专为 Agent8 SDK 提供上下文服务。它允许开发者通过标准化的 MCP 协议,便捷地为 Agent8 SDK 集成 Prompt 模板和工具,从而扩展 Agent8 SDK 的功能和灵活性。该服务器使用 TypeScript 和 pnpm 开发,支持 Stdio 和 SSE 两种传输协议,方便在不同环境中使用。

主要功能点

  • Prompt 模板管理: 内置 'system-prompt-for-agent8-sdk' Prompt 模板,为 Agent8 SDK 开发提供优化的系统提示。
  • 工具注册与执行: 集成 'search_code_examples' 工具,支持从向量数据库检索 Agent8 游戏开发代码示例。
  • 标准 MCP 协议: 遵循 MCP 协议规范,易于与任何 MCP 客户端集成。
  • 多种传输协议: 支持 Stdio 和 SSE 传输协议,适应不同的部署和使用场景。
  • 灵活配置: 支持命令行参数和环境变量配置,方便用户自定义服务器行为。
  • 详细日志: 提供多种日志输出选项(stdout, stderr, file, none)和日志级别控制,便于问题排查和监控。

安装步骤

  1. 安装依赖: 确保已安装 pnpm,然后克隆仓库并在项目根目录下运行:

    pnpm install
  2. 构建项目: 运行构建命令编译 TypeScript 代码:

    pnpm build

服务器配置

对于 MCP 客户端(例如 Claude Desktop),需要配置连接到 Agent8 MCP Server 的信息。以下是 Claude Desktop 的配置示例,您可以根据您的 MCP 客户端进行相应配置:

{
  "mcpServers": {
    "Agent8": {
      "command": "npx",
      "args": ["--yes", "agent8-mcp-server"]
    }
  }
}

配置参数说明:

  • 'server name': 服务器名称,例如 "Agent8",用于在客户端中标识和选择服务器。
  • 'command': 启动 Agent8 MCP Server 的命令,通常为 'npx' 或服务器可执行文件的路径。
  • 'args': 传递给启动命令的参数数组,'["--yes", "agent8-mcp-server"]' 表示使用 'npx' 执行 'agent8-mcp-server' 命令。

更多启动参数:

Agent8 MCP Server 支持以下启动参数,您可以根据需要添加到 'args' 数组中:

  • '--debug': 启用 debug 模式,输出更详细的日志信息。
  • '--transport <type>': 指定传输协议,可选 'stdio' 或 'sse',默认为 'stdio'。
  • '--port <number>': 当使用 'sse' 传输协议时,指定服务器监听的端口号,默认为 '3000'。
  • '--log-destination <dest>': 指定日志输出目标,可选 'stdout', 'stderr', 'file', 'none',默认为 'stderr' (stdio 传输) 或 'stdout' (sse 传输)。
  • '--log-file <path>': 当 'log-destination' 为 'file' 时,指定日志文件路径。
  • '--log-level <level>': 指定日志级别,可选 'debug', 'info', 'warn', 'error',默认为 'info'。
  • '--env-file <path>': 指定 '.env' 配置文件路径,用于加载环境变量。

环境变量配置:

服务器还支持通过环境变量进行配置。您可以创建 '.env' 文件或直接设置系统环境变量。常用的环境变量包括:

  • 'MCP_TRANSPORT': 传输协议类型 ('stdio' 或 'sse')。
  • 'MCP_PORT': SSE 传输端口号。
  • 'LOG_LEVEL': 日志级别。
  • 'LOG_DESTINATION': 日志输出目标。
  • 'LOG_FILE': 日志文件路径。
  • 'DEBUG': 是否启用 debug 模式 ('true' 或 'false')。
  • 'SUPABASE_URL': Supabase 数据库 URL (必需)。
  • 'SUPABASE_SERVICE_ROLE_KEY': Supabase 服务角色密钥 (必需)。
  • 'OPENAI_API_KEY': OpenAI API 密钥 (必需)。

基本使用方法

  1. 启动服务器: 根据需要选择传输协议和配置参数启动服务器。例如,使用 Stdio 传输:

    pnpm start --transport=stdio

    或使用 SSE 传输 (默认端口 3000):

    pnpm start --transport=sse
  2. 客户端连接: 配置 MCP 客户端连接到 Agent8 MCP Server。根据客户端的具体配置方式,填入服务器启动命令和参数。

  3. 使用 Prompt 和 Tool: 客户端连接成功后,即可通过 MCP 协议调用服务器提供的 Prompt 模板和工具,例如 'system-prompt-for-agent8-sdk' Prompt 和 'search_code_examples' Tool。具体调用方式请参考 MCP 客户端的文档。

添加新的 Prompt

如果您需要添加新的 Prompt 模板,可以修改 'src/prompts/provider.ts' 文件中的 'registerSamplePrompts' 方法,按照示例格式注册新的 Prompt。

信息

分类

开发者工具