Skip to main content
クイックスタート

概要

Qoder Agent SDK を使用すると、TypeScript または Python アプリケーションから Qoder をコーディング Agent として実行できます。生成テキストを返すだけでなく、プロジェクトの調査、許可されたツールの使用、ファイルの編集、コマンドの実行を行い、構造化された結果を返します。 対話型ターミナルを自動操作することなく、スクリプト、サービス、CI ジョブ、開発者ツール、社内ワークフローにコーディング Agent の機能を組み込みたい場合に使用します。

SDK と qodercli の役割

SDK はアプリケーション向けの API です。qodercli はタスクの計画、モデルとの通信、対象環境でのツール実行を担う Agent ランタイムです。 
TypeScript または Python アプリケーション
                 |
                 |  Qoder Agent SDK
                 |  タスク、オプション、イベント、制御指示
                 v
              qodercli
                 |
                 +-- Qoder モデルサービス
                 +-- ファイル、コマンド、MCP ツール、サブ Agent
サポート対象プラットフォーム向けに公開された SDK パッケージには、互換性のある qodercli ランタイムが含まれています。通常は CLI を別途セットアップする必要はありません。ランタイムを自分で管理する場合は、使用する qodercli 実行ファイルを明示できます。 起動処理、通信、Agent ループの詳細は、動作の仕組みを参照してください。

SDK を選ぶ

Agent をホストするアプリケーションと同じ言語の SDK を使用します。
TypeScriptPython
パッケージ@qoder-ai/qoder-agent-sdkqoder-agent-sdk
実行要件Node.js 18+Python 3.10+
単発タスクquery()query()
複数ターンのセッションquery() への非同期メッセージ入力QoderSDKClient
出力型付きメッセージの非同期ストリーム型付きメッセージオブジェクトの非同期ストリーム
npm install @qoder-ai/qoder-agent-sdk
両方の言語の実行可能なサンプルは、クイックスタートを参照してください。

プログラミングモデル

一般的な統合は、次の 4 つの部分で構成されます。
  1. タスクを記述する。 プロンプトを送信し、必要に応じて作業ディレクトリ、モデル、システムプロンプト、最大ターン数を設定します。
  2. 境界を設定する。 使用可能なツールと権限モードを選択するか、アプリケーションによる確認が必要な操作のためのコールバックを提供します。
  3. メッセージストリームを処理する。 Agent の内容、ツールの動作、進捗イベント、最後の result メッセージを処理します。
  4. 必要に応じてセッションを制御する。 長時間接続では、後続メッセージの送信、処理の中断、一部の実行設定の変更、セッション状態の照会ができます。
単発タスクには、文字列プロンプトを指定した query() を使用します。それまでの出力に応じて次の入力を決める場合は、入力モードに記載された言語別の複数ターン方式を使用してください。

設定できる機能

領域アプリケーションでできること
入出力単発または複数ターンの入力、構造化メッセージ、増分ストリーミングイベント
ツール組み込みのファイル・コマンドツール、カスタムツール、外部またはプロセス内 MCP サーバー
Agent の動作システムプロンプト、モデル、Skills、プラグイン、再利用可能な Agent 定義、サブ Agent
安全性と制御ツールの許可リスト、権限モード、承認コールバック、Hooks、中断、ターン制限
セッション管理作業ディレクトリ、セッションの永続化、再開、Checkpoint、使用量、コンテキスト情報
SDK Referencesでは、共通概念と各言語の API の対応を確認できます。

実行の境界

Agent は実際の変更を行うことができます。作業ディレクトリ、ツール、認証情報、権限ポリシーを、アプリケーションのセキュリティ境界の一部として扱ってください。
  • SDK と qodercli の通信はデフォルトではローカルですが、qodercli は Qoder モデルサービスと通信します。プロンプトと推論に必要なコンテキストがサービスへ送信される場合があります。
  • ファイルの書き込みとコマンドは、qodercli が起動された環境で実行されます。cwd を明示し、権限で操作を制限してください。
  • モデルがファイルへ直接アクセスしたり、コマンドを直接実行したりすることはありません。モデルがツール呼び出しを要求し、qodercli が設定されたポリシーに従って検証、実行します。
  • 権限確認を省略するモードは、外部で適切な分離境界を用意している環境でのみ使用してください。

次のステップ

クイックスタート
基本概念
会話とセッション
拡張機能
制御と可観測性
リファレンス