Skip to main content
リファレンス

SDK リファレンス

Qoder Agent SDK は TypeScript と Python の2言語で提供されます。両者は同じコア機能——Agent ループ、ツール、権限、Hooks、セッション、MCP、Skills、プラグイン——をカバーしますが、API シグネチャ、型定義、命名はそれぞれの言語の慣習に従います(TypeScript は camelCase、Python の公開 options は snake_case)。一部のオプションは片方の言語のみで提供されています。下記の言語間の差分を参照してください。完全な API リファレンスは言語ごとに管理されています:

言語別リファレンス

言語リファレンスパッケージ
TypeScriptSDK リファレンス - TypeScript@qoder-ai/qoder-agent-sdk
PythonSDK References - Pythonqoder-agent-sdk

言語間の差分

ほとんどのオプションは両 SDK で一対一に対応しますが、以下は例外です。各言語のリファレンスページが、その言語の機能範囲についての権威となります。

TypeScript のみ

機能オプションまたはメソッド備考
メモリmemoryflushMemory()refreshMemory()ネイティブまたはアプリケーション主導のメモリを設定
組み込みツールの挙動toolConfig組み込みツールの挙動を調整。ツールを参照
セッション永続化の制御persistSessionresumeSessionAtresumeDropsTurn再開時に読み込む内容と保持する内容を細かく制御
プロンプトの提案promptSuggestions後続プロンプトの提案を受信
モデルリクエストの調整modelRequestPatches送信するモデルリクエストを調整
Hook イベントの選別includeHookEventsメッセージストリームに流す Hook イベントを選択
トランスポートとプロセスの制御transportspawnQoderCLIProcessexecutableexecutableArgsランタイムの起動方法や接続方法を差し替え

Python のみ

機能オプション備考
ファイルからシステムプロンプトを読み込むsystem_prompt={"type": "file", "path": ...}TypeScript には対応する形式がないため、自らファイルを読んで文字列として渡す
MCP 認証コールバックon_mcp_oauth_requiredOAuth が必要な場合の入力コールバック。TypeScript はランタイムメソッドで同等の処理を行う
MCP ステータスコールバックon_mcp_status_changeサーバーの状態変化を受け取るコールバック
読み取りバッファ上限max_buffer_sizeトランスポートの読み取りバッファを制限

命名対応表

2つの SDK のコア API 対応表です。言語間移行の参考にしてください:
機能TypeScriptPython
単発クエリquery()query()
ストリーミング入力query() + 非同期メッセージストリームQoderSDKClient
セッション optionsOptionsquery({ options })QoderAgentOptions
認証:環境変数の PATaccessTokenFromEnv()access_token_from_env()
認証:PAT を直接渡すaccessToken()access_token()
認証:Service AccountserviceAccount()service_account()
認証:ローカルログイン状態qodercliAuth()qodercli_auth()
カスタムツールtool()@tool() デコレーター
インプロセス MCP servercreateSdkMcpServer()create_sdk_mcp_server()
権限コールバックcanUseToolcan_use_tool
現在の応答を中断q.interrupt()client.interrupt()
ファイル巻き戻しq.rewindFiles()client.rewind_files()
MCP 状態クエリq.mcpServerStatus()client.get_mcp_status()
初期化結果q.initializationResult()client.get_server_info()
コンテキスト使用量q.getContextUsage()client.get_context_usage()
アカウントとセッションの使用量q.getUsageInfo()client.get_usage_info()
注意:Python のプロトコルレベル構造——AgentDefinition、hooks の出力、settings など——はワイヤプロトコルの camelCase フィールド名(maxTurnshookSpecificOutput など)を維持しており、公開 options の snake_case とは異なります。詳細は各機能ページを参照してください。

機能ドキュメント

各機能ページには両言語の例がマージされており、コードブロック内で TypeScript / Python を切り替えられます: