MCP Server for Agent8

by planetarium
Verified

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Integrations

  • Supports configuration via .env files for managing environment variables

  • Provides containerized deployment options through Docker, including GitHub Container Registry integration

  • Offers container image distribution through GitHub Container Registry

Agent8 的 MCP 服务器

一个实现模型上下文协议 (MCP) 的服务器,用于支持 Agent8 SDK 开发。使用 TypeScript 和 pnpm 开发,支持 stdio 和 SSE 传输。

特征

该 Agent8 MCP 服务器实现了以下 MCP 规范功能:

提示

  • Agent8 SDK 的系统提示:通过system-prompt-for-agent8-sdk提示模板为 Agent8 SDK 开发提供优化指南。

工具

  • 代码示例搜索:使用search_code_examples工具从矢量数据库中检索相关的 Agent8 游戏开发代码示例。
  • 游戏资源搜索:通过search_game_resources工具使用语义相似性匹配来搜索游戏开发资产(精灵、动画、声音等)。

安装

# Install dependencies pnpm install # Build pnpm build

使用 Docker

您可以通过多种方式使用 Docker 运行此应用程序:

选项 1:从 GitHub Container Registry 拉取(推荐)

# Pull the latest image docker pull ghcr.io/planetarium/mcp-agent8:latest # Run the container docker run -p 3333:3333 --env-file .env ghcr.io/planetarium/mcp-agent8:latest

选项 2:本地构建

# Build the Docker image docker build -t agent8-mcp-server . # Run the container with environment variables docker run -p 3333:3333 --env-file .env agent8-mcp-server

Docker环境配置

使用Docker运行时配置环境变量有三种方式:

  1. 使用--env-file (推荐):
    # Create and configure your .env file first cp .env.example .env nano .env # Run with .env file docker run -p 3000:3000 --env-file .env agent8-mcp-server
  2. 使用单独的-e标志:
    docker run -p 3000:3000 \ -e SUPABASE_URL=your_supabase_url \ -e SUPABASE_SERVICE_ROLE_KEY=your_service_role_key \ -e OPENAI_API_KEY=your_openai_api_key \ -e MCP_TRANSPORT=sse \ -e PORT=3000 \ -e LOG_LEVEL=info \ agent8-mcp-server
  3. 使用 Docker Compose(用于开发/生产设置):该项目包含一个预先配置的docker-compose.yml文件,其中包含:
    • 从 .env 配置自动映射端口
    • 环境变量加载
    • 用于数据持久化的卷挂载
    • 容器自动重启策略
    • 健康检查配置

    运行服务器:

    docker compose up

    要在分离模式下运行:

    docker compose up -d

所需的环境变量:

  • SUPABASE_URL :用于数据库连接的 Supabase URL
  • SUPABASE_SERVICE_ROLE_KEY :用于身份验证的 Supabase 服务角色密钥
  • OPENAI_API_KEY :用于 AI 功能的 OpenAI API 密钥

Dockerfile 使用多阶段构建过程来创建最小生产映像:

  • 使用 Node.js 20 Alpine 作为基础镜像,以减小体积
  • 分离构建和运行时依赖关系
  • 最终图像仅包含必要的文件
  • 默认暴露端口 3000

用法

命令行选项

# View help pnpm start --help # View version information pnpm start --version

支持的选项:

  • --debug :启用调试模式
  • --transport <type> :传输类型(stdio 或 sse),默认值:stdio
  • --port <number> :用于 SSE 传输的端口,默认值:3000
  • --log-destination <dest> :日志目标(stdout、stderr、file、none)
  • --log-file <path> :日志文件的路径(当日志目标是文件时)
  • --log-level <level> :日志级别(debug、info、warn、error),默认值:info
  • --env-file <path> :.env 文件的路径

使用环境变量

服务器支持通过环境变量进行配置,可以直接设置,也可以通过.env文件设置。

  1. 在项目根目录中创建一个.env文件(请参阅.env.example以供参考):
# Copy the example file cp .env.example .env # Edit the .env file with your settings nano .env
  1. 运行服务器(它会自动加载.env文件):
pnpm start
  1. 或者指定.env文件的自定义路径:
pnpm start --env-file=/path/to/custom/.env

配置优先级

服务器在确定配置值时使用以下优先级顺序:

  1. 命令行参数(最高优先级)
  2. 环境变量(来自.env文件或系统环境)
  3. 默认值(最低优先级)

这使您可以在.env文件中设置基线配置,同时在需要时通过命令行参数覆盖特定设置。

支持的环境变量

多变的描述默认
MCP_传输传输类型(stdio 或 sse)标准输入输出
港口用于 SSE 传输的端口3000
日志级别日志级别(调试、信息、警告、错误)信息
日志目的地日志目标(stdout、stderr、文件、无)stderr(用于 stdio 传输)、stdout(用于 sse 传输)
日志档案日志文件的路径(当 LOG_DESTINATION 为文件时)(没有任何)
调试启用调试模式(true/false)错误的
SUPABASE_URLSupabase 数据库连接 URL(必需的)
SUPABASE_SERVICE_ROLE_KEYSupabase 服务角色密钥用于身份验证(必需的)
OPENAI_API_密钥用于 AI 功能的 OpenAI API 密钥(必需的)
启用所有工具全局启用或禁用所有工具真的
启用矢量搜索工具启用或禁用所有矢量搜索工具真的
启用电影工具启用或禁用所有电影工具真的
启用代码示例搜索工具启用或禁用代码示例搜索工具真的
启用游戏资源搜索工具启用或禁用游戏资源搜索工具真的

工具激活优先级:工具激活设置遵循以下优先级顺序:

  1. 单独的工具设置(例如, ENABLE_CODE_EXAMPLE_SEARCH_TOOL
  2. 工具组设置(例如, ENABLE_VECTOR_SEARCH_TOOLS
  3. 全局工具设置( ENABLE_ALL_TOOLS

例如,如果您设置了ENABLE_ALL_TOOLS=false ,但ENABLE_VECTOR_SEARCH_TOOLS=true ,则仅矢量搜索工具将启用,其他工具将保持禁用状态。同样,单个工具的设置会覆盖其各自的组设置。

例子

# Enable only vector search tools ENABLE_ALL_TOOLS=false ENABLE_VECTOR_SEARCH_TOOLS=true # Disable a specific tool while keeping others enabled ENABLE_ALL_TOOLS=true ENABLE_CODE_EXAMPLE_SEARCH_TOOL=false

使用 Stdio Transport

# Build and run pnpm build pnpm start --transport=stdio

使用 SSE 传输

# Build and run (default port: 3000) pnpm build pnpm start --transport=sse --port=3000

调试模式

# Run in debug mode pnpm start --debug

可用提示

  • systemprompt-agent8-sdk

客户端集成

与 Claude Desktop 一起使用

  1. 将以下内容添加到 Claude Desktop 配置文件( claude_desktop_config.json )中:
{ "mcpServers": { "Agent8": { "command": "npx", "args": ["--yes", "agent8-mcp-server"] } } }
  1. 重启Claude桌面

添加新提示

src/prompts/provider.ts文件中的registerSamplePrompts方法添加新的提示。

执照

麻省理工学院

You must be authenticated.

A
security – no known vulnerabilities
F
license - not found
A
quality - confirmed to work

实现模型上下文协议 (MCP) 的服务器通过 stdio 和 SSE 传输提供系统提示和代码示例搜索功能来支持 Agent8 SDK 开发。

  1. Features
    1. Prompts
    2. Tools
  2. Installation
    1. Using Docker
  3. Usage
    1. Command Line Options
    2. Using Environment Variables
    3. Using Stdio Transport
    4. Using SSE Transport
    5. Debug Mode
  4. Available Prompts
    1. Client Integration
      1. Using with Claude Desktop
      2. Adding New Prompts
    2. License
      ID: 72qko8mjvv