Docs: cover the A2A HTTP and JSON-RPC transport for kagent 1.x
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- grpc
- 領域
- api, documentation
調査の方向性
Read docs/architecture/a2a-transports.md and substrate-runtime/identity.md, then run examples/a2a-agents.md as written. Fetch an Agent Card, exercise JSON-RPC streaming and share-token permissions, and verify ingress behavior against a live instance. Done means the guide documents both transports, routing and naming changes, ingress requirements, and a resolved exposure policy.
索引モデルが issue の本文から書いたものです。
説明
[!IMPORTANT]
Rewritten for 1.0.0-alpha5 on 2026-09-29. This issue was filed against alpha4 and described a per-AgentInstance endpoint. alpha5 changed the URL shape, the resource it addresses, and the gRPC routing field. The original scoping is superseded; what follows is verified against thev1.0.0-alpha5tag. Part of #549.
examples/a2a-agents.md uses grpcurl throughout and documents no HTTP path. kagent serves A2A over HTTP/JSON-RPC alongside gRPC, with a discoverable Agent Card, and a reader who wants an ordinary HTTP client has nothing to follow.
Upstream's docs/architecture/a2a-transports.md is the endpoint contract and the right source. It is an architecture document rather than a task guide.
The endpoint surface
Both transports are served on the controller's API listener, port 8083 by default, and share the same Session authorization, durable tasks, history, and runtime lifecycle.
| Operation | Path |
|---|---|
| Read the Agent Card | GET /agents/{namespace}/{name}/.well-known/agent-card.json |
| Call JSON-RPC, including streaming | POST /agents/{namespace}/{name} |
The URL addresses an Agent, not an AgentInstance. This is the alpha5 change: alpha4 served /agents/{instance-id}, and the resource that a conversation belongs to is now a Session.
- HTTP requests need no
tenant. gRPC requests use the standard A2Atenantfield asnamespace/name, advertised only on the card's gRPC interface. An HTTP request that does supply a tenant must have it match the URL. Session.idis the messagecontextId. Omitting both context and task IDs creates a new conversation; retrying that first message with the same message ID reuses it. A task-only request resolves the conversation from the globally unique task ID.- There is no deployment-wide Agent Card, because the gateway serves many agents.
JSON-RPC uses the pinned upstream A2A v1 SDK: SendMessage, SendStreamingMessage, GetTask, ListTasks, CancelTask, SubscribeToTask, and GetExtendedAgentCard. Those are the v1 names for what older clients called message/send, message/stream, tasks/get, tasks/list, tasks/cancel, and tasks/resubscribe, which is worth stating for anyone arriving with a pre-v1 client.
Behavior the API does not announce
controller.a2aGatewayUrlchanged meaning in alpha4 and still holds. It was the public gRPC URL advertised by Agent Cards; it is now the gateway base URL for both transports, and HTTP interfaces append the agent path to it, preserving any deployment prefix. Its default is the controller's cluster Service URL.- An ingress with a prefix must strip it before forwarding to the core listener, and must forward streaming responses without buffering. Neither is enforced by a chart value.
- The card advertises JSON-RPC first, then gRPC. It comes from the Agent's latest successful revision, or from a shared session's pinned revision, and retains runtime extensions while reporting the gateway's streaming capabilities.
- Share tokens grade by permission. A validated
X-Share-Tokensupplements the authenticated user's access to its session: a read-only share permits card and task reads and subscriptions, and a read-write share also permits messages and cancellation. Cards are not publicly cached.
The conflict to resolve before writing
substrate-runtime/identity.md warns against exposing port 8083 outside the cluster, because the open source build's authenticator admits every request. The HTTP transport is served on that same listener, and the architecture document describes setting a2aGatewayUrl and putting an ingress in front precisely so agents can be reached from outside.
alpha5 changes this picture and it must be re-checked before writing. kagent#2971 restored controller.auth.mode and controller.auth.userIdClaim, so the permissive posture is no longer the only option. Establish what the authenticated configuration actually allows, then say which argument won. This is the main open question in this issue.
What to check before starting
- Read
docs/architecture/a2a-transports.mdat the release being documented. - Run the existing
examples/a2a-agents.mdguide as written, so the gRPC path is known to work before an HTTP path joins it. Note that the page is written around AgentInstance and needs the Session rename from #549 regardless. - Fetch a card over HTTP and confirm the interface ordering and retained extensions.
- Exercise streaming over JSON-RPC, and confirm what a client sees when an ingress buffers.
- Confirm the share-token grading through both transports rather than inferring it.
Done when
- Both endpoint paths are documented in their alpha5 form, with a working
curlexample for the card and for a JSON-RPC call. - The page states that the URL addresses an Agent, and that
Session.idis thecontextId. - The v1 method names are listed against their pre-v1 equivalents.
- The
a2aGatewayUrlmeaning is covered wherever that value is documented. - The ingress requirements, prefix stripping and unbuffered streaming, are stated.
- The exposure question against
identity.mdis resolved against alpha5 authentication rather than left for the reader. - Every command was run against a live Agent.
- 主要言語
- TypeScript
- スター
- 20
- フォーク
- 66
- 平均マージ
- 1日 2時間
- マージ済み PR(30日)
- 49
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
kagent-dev/website のほかの issue
-
Hold until GA: repoint kagent.dev navigation from 0.x to 1.x対応中かも @Rachael-Graham が 8 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
kagent-dev/website#521 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
documentation kagent
難易度 4/5 3〜5日 初心者へのやさしさ 60/100
kagent-dev/website#562 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 64/100
kagent-dev/website#557 ·
メンテナーはふだん 1 日以内に返信
-
help wanted
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
kagent-dev/website#539 ·
メンテナーはふだん 1 日以内に返信
-
help wanted
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
kagent-dev/website#537 ·
メンテナーはふだん 1 日以内に返信
kagent-dev/website の issue をすべて見る
似ている issue
-
bug DUP Reservations
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
bcgov/reserve-rec-public#952 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
daufderheide/racecoordinator_ai#948 ·
メンテナーはふだん 1 日以内に返信
-
Bug pulumi/pulumi
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
bug priority:high
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
api bug claude
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
diegosouzapw/OmniRoute#15764 ·
メンテナーはふだん 2 日以内に返信