typescript-sdk について
TypeScript SDK でエージェント、サブエージェント、ツールとその関係を定義するためのルール集です。MCP ツールの設定、CLI、実行制限、メモリ、トリガーについても扱います。
主な機能
- 01エージェント、サブエージェント、ツールの定義
- 02サブエージェント関係の設定
- 03MCP ツールと認証の設定
- 04CLI とプロジェクト設定の管理
- 05実行制限、メモリ、トリガーの設定
活用シーン
- 01TypeScript エージェント設定の参照
- 02エージェント向け MCP ツールの登録と選択
- 03エージェントを呼び出す Webhook の設定
MCP 対応
MCP サーバーをエージェントのツールとして登録する方法や、ツールの選択、認証、上書き設定、環境別設定を説明します。
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ inkeep/ skills --skill typescript-sdkインストール後、Claude Code で/typescript-sdkを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
rules/agent-relationships-overview.mdagent-relationships-when-to-use.mdartifact-components-definition.mdcli-add-command.mdcli-config-command.mdcli-config-file-structure.mdcli-dev-command.mdcli-environment-variables.mdcli-init-command.mdcli-list-agents-command.mdcli-login-command.mdcli-logout-command.mdcli-profile-command.mdcli-pull-command.mdcli-push-command.mdcli-update-command.mdconfig-hierarchy.mdcontext-fetchers-overview.mdcredential-store-options.mddata-components-definition.mddata-operation-types.mddata-operations-overview.mddelegation-types.mdexternal-agents-overview.mdfunction-tools-execution.mdfunction-tools-overview.mdheaders-passing-context.mdheaders-usage.mdmcp-environment-aware.mdmcp-tool-auth.md詳細
Typescript Sdk
概要
TypeScript SDK では、エージェント、サブエージェント、ツール、およびそれらの関係を宣言的に定義できます。
ルール(49)
特定のタスクやトピックについて詳しい説明やコード例を確認するには、各ルールファイルをお読みください。
| タイトル | トピック | 説明 |
|---|---|---|
| サブエージェントの関係性の概要 | typescript-sdk/agent-relationships | サブエージェント間の転送および委任の関係 |
| 転送と委任の使い分け | typescript-sdk/agent-relationships | 転送と委任の関係を選択するためのガイドライン |
| 委任関係の種類 | typescript-sdk/agent-relationships | サブエージェント、外部エージェント、チームエージェントへの委任 |
| StopWhen の設定 | typescript-sdk/agent-settings | エージェントの無限ループを防ぐための停止条件の制御 |
| サブエージェントのパラメーターリファレンス | typescript-sdk/agent-settings | subAgent() の設定に関する完全なパラメーターリファレンス |
| CLI inkeep add コマンド | typescript-sdk/cli-reference | Inkeep Agents Cookbook からテンプレートプロジェクトまたは MCP を取得 |
| CLI inkeep config コマンド | typescript-sdk/cli-reference | Inkeep の設定値を管理 |
| CLI 設定ファイルの構造 | typescript-sdk/cli-reference | inkeep.config.ts の構造と設定の優先順位 |
| CLI inkeep dev コマンド | typescript-sdk/cli-reference | エージェントを視覚的にオーケストレーションするための Inkeep ダッシュボードサーバーを起動 |
| CLI 環境変数 | typescript-sdk/cli-reference | CLI と SDK が参照する環境変数 |
| CLI inkeep init コマンド | typescript-sdk/cli-reference | プロジェクトに新しい Inkeep 設定ファイルを初期化 |
| CLI inkeep list-agent コマンド | typescript-sdk/cli-reference | 特定のプロジェクトで利用可能なすべてのエージェントを一覧表示 |
| CLI inkeep login コマンド | typescript-sdk/cli-reference | デバイスコードフローを使用してデプロイメントを認証 |
| CLI inkeep logout コマンド | typescript-sdk/cli-reference | プロファイルに保存された認証情報を消去 |
| CLI inkeep profile コマンド | typescript-sdk/cli-reference | 複数のリモート、認証情報、環境に対応する名前付き CLI プロファイルを管理 |
| CLI inkeep pull コマンド | typescript-sdk/cli-reference | サーバーからプロジェクト設定を取得し、ローカルの TypeScript ファイルを更新 |
| CLI inkeep push コマンド | typescript-sdk/cli-reference | エージェント設定をサーバーにプッシュ |
| CLI inkeep update コマンド | typescript-sdk/cli-reference | Inkeep CLI を最新バージョンに更新 |
| ランタイム制限の設定 | typescript-sdk/configure-runtime-limits | 実行制限、タイムアウト、制約の設定方法 |
| ランタイム設定変数 | typescript-sdk/configure-runtime-limits | ランタイム制限の設定に使用できるすべての環境変数 |
| コンテキストフェッチャーの概要 | typescript-sdk/context-fetchers | コンテキストフェッチャーを使用してリアルタイムデータをエージェントのプロンプトに埋め込む方法 |
| 認証情報ストアの選択肢 | typescript-sdk/credentials/overview | MCP サーバーと外部エージェントの認証情報を保存するための選択肢 |
| データ操作の種類のリファレンス | typescript-sdk/data-operations | すべてのデータ操作イベントの種類とペイロード |
| データ操作の概要 | typescript-sdk/data-operations | デバッグとモニタリングのためにデータ操作を有効化して使用する方法 |
| 外部エージェントの概要 | typescript-sdk/external-agents | A2A プロトコルを使用して外部エージェントを設定し、使用する方法 |
| ヘッダー経由でのコンテキストの受け渡し | typescript-sdk/headers | HTTP ヘッダー経由で動的コンテキストをエージェントに渡す方法 |
| エージェントでのヘッダーの使用 | typescript-sdk/headers | プロンプト、コンテキストフェッチャー、外部ツールでヘッダー値を使用する方法 |
| 会話メモリの概要 | typescript-sdk/memory | 会話履歴の管理方法とコンテキストウィンドウへの追加方法 |
| モデルの種類のリファレンス | typescript-sdk/models | 設定階層で各モデルの種類を使い分ける方法 |
| モデルプロバイダーの選択肢 | typescript-sdk/models | さまざまなモデルプロバイダーの設定オプション |
| サポート対象モデルのリファレンス | typescript-sdk/models | サポート対象のモデルプロバイダーとその API キーの一覧 |
| アーティファクトコンポーネントの定義 | typescript-sdk/structured-outputs/artifact-components | 引用とソースのプレビューフィールドを含むアーティファクトコンポーネントの定義方法 |
| データコンポーネントの定義 | typescript-sdk/structured-outputs/data-components | Zod スキーマを使用してデータコンポーネントを定義する方法 |
| ステータス更新の設定 | typescript-sdk/structured-outputs/status-updates | エージェント向けの AI によるステータス更新を設定する方法 |
| 関数ツールの実行環境 | typescript-sdk/tools/function-tools | サンドボックスプロバイダー、ランタイム設定、セキュリティ保証 |
| 関数ツールの概要 | typescript-sdk/tools/function-tools | 関数ツールのユースケースと作成方法 |
| 環境対応 MCP サーバー | typescript-sdk/tools/mcp-tools | 環境(開発環境と本番環境)に応じて切り替わるよう MCP ツールを設定 |
| MCP ツールの認証 | typescript-sdk/tools/mcp-tools | API キー、OAuth、カスタムヘッダーなど、MCP サーバーの認証方法 |
| MCP ツールのオーバーライド | typescript-sdk/tools/mcp-tools | 個々の MCP ツールがエージェントにどのように表示されるかをカスタマイズ |
| MCP ツールの選択 | typescript-sdk/tools/mcp-tools | MCP サーバーのツールを選択的に有効化する方法 |
| MCP サーバーをツールとして登録 | typescript-sdk/tools/mcp-tools | エージェント向けに MCP ツールを登録して設定する方法 |
| ツール承認の設定 | typescript-sdk/tools/tool-approvals | 実行前にユーザーの承認を必要とするようツールを設定する方法 |
| ツール承認リクエストへの応答 | typescript-sdk/tools/tool-approvals | ツールの実行リクエストを承認または拒否する方法 |
| トリガーの設定オプション | typescript-sdk/triggers/overview | 認証、スキーマ、変換を含むトリガーの設定オプション |
| トリガーの概要 | typescript-sdk/triggers/overview | 外部サービスからエージェントを呼び出すための Webhook エンドポイントの作成 |
| トリガーの設定オプション | typescript-sdk/triggers/webhooks | 認証、スキーマ、変換を含むトリガーの設定オプション |
| トリガーの概要 | typescript-sdk/triggers/webhooks | 外部サービスからエージェントを呼び出すための Webhook エンドポイントの作成 |
| 設定の優先順位 | typescript-sdk/workspace-configuration | CLI フラグ、環境変数、設定ファイルの値がどのように解決されるか |
| ワークスペース設定ファイル | typescript-sdk/workspace-configuration | inkeep.config.ts の構造とオプション |
その他のリソース
詳しくは、以下をご覧ください。
- ドキュメント全文:https://docs.inkeep.com/(llms.txt と llms-full.txt も利用できます!)
- GitHub リポジトリ(オープンソース):https://github.com/inkeep/agents
コメント
Markdown 対応