Speelka Agent

🚀 《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 start custom-agent --config config.yaml