Skip to content

Remote Subagents (experimental)

Gemini CLI supports connecting to remote subagents using the Agent-to-Agent (A2A) protocol. This allows Gemini CLI to interact with other agents, expanding its capabilities by delegating tasks to remote services.

Gemini CLI can connect to any compliant A2A agent. You can find samples of A2A agents in the following repositories:

Note: Remote subagents are currently an experimental feature.

To use remote subagents, you must explicitly enable them in your settings.json:

{
"experimental": {
"enableAgents": true
}
}

Gemini CLI routes traffic to remote agents through an HTTP/HTTPS proxy if one is configured. It uses the general.proxy setting in your settings.json file or standard environment variables (HTTP_PROXY, HTTPS_PROXY).

{
"general": {
"proxy": "http://my-proxy:8080"
}
}

Remote subagents are defined as Markdown files (.md) with YAML frontmatter. You can place them in:

  1. Project-level: .gemini/agents/*.md (Shared with your team)
  2. User-level: ~/.gemini/agents/*.md (Personal agents)
FieldTypeRequiredDescription
kindstringYesMust be remote.
namestringYesA unique name for the agent. Must be a valid slug (lowercase letters, numbers, hyphens, and underscores only).
agent_card_urlstringYesThe URL to the agent’s A2A card endpoint.
authobjectNoAuthentication configuration. See Authentication.
---
kind: remote
name: my-remote-agent
agent_card_url: https://example.com/agent-card
---

The loader explicitly supports multiple remote subagents defined in a single Markdown file.

---
- kind: remote
name: remote-1
agent_card_url: https://example.com/1
- kind: remote
name: remote-2
agent_card_url: https://example.com/2
---

Note: Mixed local and remote agents, or multiple local agents, are not supported in a single file; the list format is currently remote-only.

Many remote agents require authentication. Gemini CLI supports several authentication methods aligned with the A2A security specification. Add an auth block to your agent’s frontmatter to configure credentials.

Gemini CLI supports the following authentication types:

TypeDescription
apiKeySend a static API key as an HTTP header.
httpHTTP authentication (Bearer token, Basic credentials, or any IANA-registered scheme).
google-credentialsGoogle Application Default Credentials (ADC). Automatically selects access or identity tokens.
oauth2OAuth 2.0 Authorization Code flow with PKCE. Opens a browser for interactive sign-in.

For apiKey and http auth types, secret values (key, token, username, password, value) support dynamic resolution:

FormatDescriptionExample
$ENV_VARRead from an environment variable.$MY_API_KEY
!commandExecute a shell command and use the trimmed output.!gcloud auth print-token
literalUse the string as-is.sk-abc123
$$ / !!Escape prefix. $$FOO becomes the literal $FOO.$$NOT_AN_ENV_VAR

Security tip: Prefer $ENV_VAR or !command over embedding secrets directly in agent files, especially for project-level agents checked into version control.

Sends an API key as an HTTP header on every request.

FieldTypeRequiredDescription
typestringYesMust be apiKey.
keystringYesThe API key value. Supports dynamic values.
namestringNoHeader name to send the key in. Default: X-API-Key.
---
kind: remote
name: my-agent
agent_card_url: https://example.com/agent-card
auth:
type: apiKey
key: $MY_API_KEY
---

Supports Bearer tokens, Basic auth, and arbitrary IANA-registered HTTP authentication schemes.

Use the following fields to configure a Bearer token:

FieldTypeRequiredDescription
typestringYesMust be http.
schemestringYesMust be Bearer.
tokenstringYesThe bearer token. Supports dynamic values.
auth:
type: http
scheme: Bearer
token: $MY_BEARER_TOKEN

Use the following fields to configure Basic authentication:

FieldTypeRequiredDescription
typestringYesMust be http.
schemestringYesMust be Basic.
usernamestringYesThe username. Supports dynamic values.
passwordstringYesThe password. Supports dynamic values.
auth:
type: http
scheme: Basic
username: $MY_USERNAME
password: $MY_PASSWORD

For any other IANA-registered scheme (for example, Digest, HOBA), provide the raw authorization value.

FieldTypeRequiredDescription
typestringYesMust be http.
schemestringYesThe scheme name (for example, Digest).
valuestringYesRaw value sent as Authorization: <scheme> <value>. Supports dynamic values.
auth:
type: http
scheme: Digest
value: $MY_DIGEST_VALUE

Google Application Default Credentials (google-credentials)

Section titled “Google Application Default Credentials (google-credentials)”

Uses Google Application Default Credentials (ADC) to authenticate with Google Cloud services and Cloud Run endpoints. This is the recommended auth method for agents hosted on Google Cloud infrastructure.

FieldTypeRequiredDescription
typestringYesMust be google-credentials.
scopesstring[]NoOAuth scopes. Defaults to https://www.googleapis.com/auth/cloud-platform.
---
kind: remote
name: my-gcp-agent
agent_card_url: https://my-agent-xyz.run.app/.well-known/agent.json
auth:
type: google-credentials
---

The provider automatically selects the correct token type based on the agent’s host:

Host patternToken typeUse case
*.googleapis.comAccess tokenGoogle APIs (Agent Engine, Vertex AI, etc.)
*.run.appIdentity tokenCloud Run services
  • Access tokens authorize API calls to Google services. They are scoped (default: cloud-platform) and fetched via GoogleAuth.getClient().
  • Identity tokens prove the caller’s identity to a service that validates the token’s audience. The audience is set to the target host. These are fetched via GoogleAuth.getIdTokenClient().

Both token types are cached and automatically refreshed before expiry.

google-credentials relies on ADC, which means your environment must have credentials configured. Common setups:

  • Local development: Run gcloud auth application-default login to authenticate with your Google account.
  • CI / Cloud environments: Use a service account. Set the GOOGLE_APPLICATION_CREDENTIALS environment variable to the path of your service account key file, or use workload identity on GKE / Cloud Run.

For security, google-credentials only sends tokens to known Google-owned hosts:

  • *.googleapis.com
  • *.run.app

Requests to any other host will be rejected with an error. If your agent is hosted on a different domain, use one of the other auth types (apiKey, http, or oauth2).

The following examples demonstrate how to configure Google Application Default Credentials.

Cloud Run agent:

---
kind: remote
name: cloud-run-agent
agent_card_url: https://my-agent-xyz.run.app/.well-known/agent.json
auth:
type: google-credentials
---

Google API with custom scopes:

---
kind: remote
name: vertex-agent
agent_card_url: https://us-central1-aiplatform.googleapis.com/.well-known/agent.json
auth:
type: google-credentials
scopes:
- https://www.googleapis.com/auth/cloud-platform
- https://www.googleapis.com/auth/compute
---

Performs an interactive OAuth 2.0 Authorization Code flow with PKCE. On first use, Gemini CLI opens your browser for sign-in and persists the resulting tokens for subsequent requests.

FieldTypeRequiredDescription
typestringYesMust be oauth2.
client_idstringYes*OAuth client ID. Required for interactive auth.
client_secretstringNo*OAuth client secret. Required by most authorization servers (confidential clients). Can be omitted for public clients that don’t require a secret.
scopesstring[]NoRequested scopes. Can also be discovered from the agent card.
authorization_urlstringNoAuthorization endpoint. Discovered from the agent card if omitted.
token_urlstringNoToken endpoint. Discovered from the agent card if omitted.
---
kind: remote
name: oauth-agent
agent_card_url: https://example.com/.well-known/agent.json
auth:
type: oauth2
client_id: my-client-id.apps.example.com
---

If the agent card advertises an oauth2 security scheme with authorizationCode flow, the authorization_url, token_url, and scopes are automatically discovered. You only need to provide client_id (and client_secret if required).

Tokens are persisted to disk and refreshed automatically when they expire.

When Gemini CLI loads a remote agent, it validates your auth configuration against the agent card’s declared securitySchemes. If the agent requires authentication that you haven’t configured, you’ll see an error describing what’s needed.

google-credentials is treated as compatible with http Bearer security schemes, since it produces Bearer tokens.

All auth providers automatically retry on 401 and 403 responses by re-fetching credentials (up to 2 retries). This handles cases like expired tokens or rotated credentials. For apiKey with !command values, the command is re-executed on retry to fetch a fresh key.

When connecting to a remote agent, Gemini CLI first fetches the agent card without authentication. If the card endpoint returns a 401 or 403, it retries the fetch with the configured auth headers. This lets agents have publicly accessible cards while protecting their task endpoints, or to protect both behind auth.

Users can manage subagents using the following commands within the Gemini CLI:

  • /agents list: Displays all available local and remote subagents.
  • /agents reload: Reloads the agent registry. Use this after adding or modifying agent definition files.
  • /agents enable <agent_name>: Enables a specific subagent.
  • /agents disable <agent_name>: Disables a specific subagent.

Tip: You can use the @cli_help agent within Gemini CLI for assistance with configuring subagents.