AI エージェント向け：セットアップの手順ガイド — /docs/agents.md、ドキュメントのインデックス — /llms.txt。
AIエージェント向け
AI エージェントに接続作業を任せる方法：あらゆるツールで使えるプロンプトを用意。以下ではドキュメントの機械可読アドレスと、エージェントがコマンド1つで導入できるスキルを紹介します。
エージェント用プロンプト#
このプロンプトをAIエージェントに送ってください。エージェントは以下の手順書に従ってツールを設定し、キーはあなたに尋ねます。
エージェント用プロンプト
自分のツールをJoinGonka Gateway（GonkaネットワークのOpenAIおよびAnthropic互換API）に、https://gate.joingonka.ai/docs/agents.mdの手順に従って接続してください。キーは私が渡します。リポジトリのファイルに保存したり、グローバル環境変数を変更したりしないでください。最後に短いリクエストで接続を確認し、結果を報告してください。以下が手順書です。エージェントは/docs/agents.mdからMarkdown形式で取得します。
ルール#
- APIキーは人間が作成します — gate.joingonka.aiの管理画面で。自分でアカウント登録やキー作成をしないでください。ユーザーにキーを求めてください。
- キーはターミナルセッションの環境変数
JOINGONKA_API_KEYに保持してください。git管理下のファイルに書き込んだり、コミットしたり、レポートに出力したりしないでください。 - グローバル変数
OPENAI_*とANTHROPIC_*は変更しないでください — シェルプロファイルでもシステムでも。ユーザーの他のツールが参照しています。キーとアドレスはツール自体の設定ファイルに書き込まれます — インストーラーがそうします。
事実#
- OpenAI APIクライアント用のベースURL:
https://gate.joingonka.ai/v1 - Anthropic APIクライアント用のベースURL（
/v1なし）:https://gate.joingonka.ai - キーは
Authorization: Bearer jg-…またはx-api-key: jg-…ヘッダーで渡します - モデル呼び出し用のキーは
jg-で始まります。管理キーgm-ではモデルにアクセスできません。 - 推奨モデル:
MiniMaxAI/MiniMax-M2.7 - 利用可能なモデル一覧:
GET https://gate.joingonka.ai/v1/models - 1キーあたり毎分120リクエストまで。超過時は
Retry-Afterヘッダー付きの429レスポンス。レート制限とタイムアウトはGET /v1/capabilitiesレスポンスのlimitsフィールドにあります。
設定#
セクション末尾の表でユーザーのツールを探してください。--toolの値があればインストーラーで設定、なければガイドに従って手動で設定します。
インストーラーを使う#
質問なしのワンコマンド：キーは環境変数から、モデルはフラグで指定。インストーラーはツールの設定を書き込み、以前のコピーを保存し、ゲートウェイへのリクエストで接続を確認します。
Bash
JOINGONKA_API_KEY=<key> npx -y @joingonka/setup --tool <id> --model MiniMaxAI/MiniMax-M2.7 --non-interactive| フラグ | 動作 |
|---|---|
--tool <id> | 設定するツール — ツール表の値。 |
--model <id> | モデルID：推奨はMiniMaxAI/MiniMax-M2.7、利用可能な全モデルはGET /v1/models。 |
--non-interactive | 質問なし：キーはJOINGONKA_API_KEYから取得。 |
--scope local | 設定をホームディレクトリではなく現在のプロジェクトに配置。Claude Codeのみ対応。設定ファイルは.gitignoreに追加されます。 |
--no-verify | 設定書き込み後の接続確認をスキップ。 |
| 終了コード | 意味 |
|---|---|
0 | 完了：設定が書き込まれ、確認リクエストが成功。ネットワークや残高の問題で確認できなかった場合、インストーラーは警告を出力しますが終了コード0で終了します — その旨をユーザーに伝えてください。 |
1 | 設定に失敗。原因は出力を確認：例えば不明な--tool値、JOINGONKA_API_KEYが未設定、キーがjg-で始まっていないなど。 |
2 | 設定は書き込まれましたが確認リクエストが失敗：キーとモデルIDを確認してください。 |
ツールが起動中だった場合は再起動してください。設定は起動時に読み込まれます。
手動で#
インストーラーのないツールの場合は、そのガイド（下の表のリンク）を開き、3つの値を設定してください：
- ベースURL — OpenAI APIクライアントなら
https://gate.joingonka.ai/v1、Anthropic APIクライアントならhttps://gate.joingonka.ai； - キー — ツール設定のAPIキーフィールドに；
- モデル —
MiniMaxAI/MiniMax-M2.7またはGET /v1/modelsの他のモデル。
ツールとガイド#
| ツール | --tool |
|---|---|
| Cursor | cursor |
| Claude Code | claude-code |
| OpenClaw | openclaw |
| OpenCode | opencode |
| Continue | continue |
| Cline | cline |
| Aider | aider |
| LangChain | — |
| n8n | — |
| Open WebUI | — |
| LibreChat | — |
| Hermes | hermes |
| Kilo Code | kilo |
| Roo Code | roo |
| LlamaIndex | — |
| PydanticAI | — |
| Vercel AI SDK | — |
| TanStack AI | — |
| ZCode | zcode |
| JetBrains | jetbrains |
| Copilot BYOK | copilot-byok |
| Zed | zed |
| Pi | pi |
| Codex CLI | codex |
| DeepSeek Harness | — |
| MiniMax Code | minimax-code |
| Warp | — |
| Trae | — |
| Cherry Studio | — |
| omp (Oh My Pi) | omp |
| OpenHands | — |
| Qwen Code | qwen-code |
| Goose | goose |
| Crush | crush |
| Zoo Code | zoo |
| Kimi Code | kimi-code |
| Factory Droid | droid |
| MiMo Code | mimo-code |
確認#
キーの確認 — 残高リクエスト：トークンを消費せず、キーはJOINGONKA_API_KEYから取得：
cURL
curl -s https://gate.joingonka.ai/api/balance \
-H "Authorization: Bearer $JOINGONKA_API_KEY"アドレス、キー、モデルの確認 — モデルへの短いリクエスト：
cURL
curl -s https://gate.joingonka.ai/v1/chat/completions \
-H "Authorization: Bearer $JOINGONKA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "MiniMaxAI/MiniMax-M2.7", "messages": [{"role": "user", "content": "Say OK"}], "max_tokens": 32}'モデルのテキスト付き200レスポンスが返れば接続は正常。インストーラーはこの確認を自動で行うため、終了コード0で十分です。
うまくいかない場合#
エラーはレスポンスボディのerrorフィールドに、原因の種類とテキストとともに返ります。
| レスポンス | 対処法 |
|---|---|
401 authentication_error | キーが拒否されました。完全にコピーされているか、Authorization: Bearerまたはx-api-keyで送信されているか確認してください。新しいキーはユーザーが作成します。 |
402 insufficient_funds | 残高不足です。ユーザーに伝えてください：残高は管理画面でチャージできます。 |
402 child_key_limit_exceeded | 子キーの上限に達しました。別のキーかより大きな上限が必要です — キー所有者が対応します。 |
403 forbidden | これは管理キーgm-です：モデルにはアクセスできません。jg-キーが必要です。 |
400 invalid_request_error | リクエストエラー。モデルが見つからない場合、エラーテキストに利用可能なIDのリストがあります — そこかGET /v1/modelsから選んでください。 |
404 model_not_found | そのモデルは現在利用できません — GET /v1/modelsから別のものを選んでください。 |
429 | リクエストが多すぎるかネットワークが混雑しています。Retry-Afterヘッダーに示された秒数待って再試行してください。 |
503 model_unavailable | ネットワークが現在そのモデルを提供していません。エラーテキストのモデルかGET /v1/modelsの別のモデルに切り替えてください。 |
504 upstream_timeout | ネットワークが時間内に応答を開始しませんでした。リクエストを再試行してください。長いレスポンスにはstream: trueを有効にしてください。 |
502 | ゲートウェイまたはネットワーク側の障害 — キーの問題ではありません。後で再試行してください。ネットワーク状態はネットワークステータスページで確認できます。 |
すべてのレスポンスコードと制限はエラーと制限セクションにあります。
レポート#
最後にユーザーに以下を伝えてください：
- どのツールが設定され、どの設定ファイルが書き込まれたか（パスはインストーラーが出力し、以前のコピーはその隣にあります）；
- ベースアドレスとモデルID。
- チェック結果：レスポンスコードとモデルの応答、またはチェックできなかった理由。
- ユーザー自身がまだ行う必要があること：たとえば、ツールの再起動や残高のチャージ。
レポートにキーを含めないでください。
マシン向けアドレス#
| アドレス | 内容 |
|---|---|
| /llms.txt | 言語モデル向けドキュメントインデックス。 |
| /llms-full.txt | 全ドキュメントを1ファイルにまとめたもの。 |
/docs/<page>.md | ドキュメントページのMarkdown版：同じアドレスの末尾に .md を付ける（/docs/models.md）か、Accept: text/markdown ヘッダーを付けてページをリクエストします。 |
GET /v1/capabilities | ゲートウェイの機能と制限 — limits フィールド。 |
GET /v1/models | 現在利用可能なモデル。 |
GET /api/pricing | モデルごとの100万トークンあたりの料金と手数料。 |
GET /v1/network-status | モデルのステータスとインシデント。 |
エージェント用スキル#
この手順はエージェントのスキル（skill）としてインストールできます。そうすればプロンプトなしでいつでも使えます：
Bash
npx skills add https://gate.joingonka.ai