Speelka Agent

🚀 《Speelka Agent》使用文檔

《Speelka Agent》是一款用於特定場景的代理工具，通過簡單配置即可快速運行，支持多種模式和配置方式，為用戶提供便捷的代理服務。

🚀 快速開始

📦 安裝指南

使用以下命令安裝最新版本的speelka-agent：

go install github.com/speelka/speelka-agent/cmd/speelka-agent@latest

⚙️ 創建配置文件

創建一個config.yaml文件，示例如下：

agent:
  id: "my-agent"         # 設置為唯一的標識符
  name: "My Agent"       # 設置為一個有意義的名字
  description: "A test agent for Speelka."   # 可選，描述你的代理
  version: "0.1"        # 可選，設置版本號

  # 配置MCP服務器連接
  connections:
    mcpServers:
      time:
        command: "docker"
        args: ["run", "-i", "--rm", "mcp/time"]
      filesystem:
        command: "mcp-filesystem-server"
        args: ["/path/to/directory"]

▶️ 運行代理

守護進程模式（HTTP服務器）

./speelka-agent --daemon [--config config.yaml]

CLI模式（標準輸入/輸出）

./speelka-agent [--config config.yaml]

📚 詳細文檔

🔧 環境變量配置

以下是通過環境變量配置代理的示例：

# 設置代理的基本信息
export SPL_AGENT_ID="my-agent"
export SPL_AGENT_NAME="My Agent"

# 配置MCP服務器連接
export SPL_MCPS_0_ID="time"
export SPL_MCPS_0_COMMAND="docker"
export SPL_MCPS_0_ARGS="run -i --rm mcp/time"

export SPL_MCPS_1_ID="filesystem"
export SPL_MCPS_1_COMMAND="mcp-filesystem-server"
export SPL_MCPS_1_ARGS="/path/to/directory"

📄 YAML配置文件參考

以下是config.yaml文件的完整參考：

agent:
  id: string         # 必填，代理的唯一標識符
  name: string       # 必填，代理的名字
  description: string   # 可選，代理的描述
  version: string    # 可選，代理的版本號

  # 配置MCP服務器連接
  connections:
    mcpServers:
      <server_id>:
        command: string          # 必填，啟動MCP服務器的命令
        args: list of strings    # 可選，傳遞給命令的參數
        includeTools: list of strings   # 可選，包含工具列表，只有這些工具會被導出
        excludeTools: list of strings   # 可選，排除的工具列表

# 運行時配置
runtime:
  logLevel: string      # 可選，默認為"info"
  logOutput: string     # 可選，默認為"stderr"
  stdioEnabled: boolean  # 可選，默認為true
  stdioBufferSize: int   # 可選，默認為8192
  httpEnabled: boolean    # 可選，默認為false
  httpHost: string       # 可選，默認為"localhost"
  httpPort: int          # 可選，默認為3000

# 支持的LLM提供程序
llmProviders:
  openai:
    enabled: boolean     # 可選，默認為true
    apiKey: string        # 必填，OpenAI API密鑰
    model: string         # 可選，默認為"gpt-3.5-turbo"
  anthropic:
    enabled: boolean      # 可選，默認為true
    apiKey: string         # 必填，Anthropic API密鑰
    model: string          # 可選，默認為"claude-2"

🔍 MCP服務器工具過濾

你可以在mcpServers部分使用以下選項控制每個MCP服務器導出的工具：

• includeTools：（可選）指定要包含的工具名稱列表。只有這些工具將從該服務器導出。
• excludeTools：（可選）指定要排除的工具名稱列表。這些工具將不會從該服務器導出。
• 如果同時設置了這兩個選項，首先應用includeTools，然後應用excludeTools。
• 工具名稱區分大小寫。

示例：

connections:
  mcpServers:
    time:
      command: "docker"
      args: ["run", "-i", "--rm", "mcp/time"]
      includeTools:
        - now
        - utc
    filesystem:
      command: "mcp-filesystem-server"
      args: ["/path/to/directory"]
      excludeTools:
        - delete

💻 使用示例

🌟 基礎用法

創建自定義代理

./speelka-agent create custom-agent --config config.yaml

運行代理

運行名為custom-agent的代理：

./speelka-agent run custom-agent --config config.yaml