Skip to main content
Glama

opencode-workbench

List required credentials

list_required_credentials
Read-onlyIdempotent

List the credentials the profile references, which the target already provides, and how to acquire each missing one (label, purpose, provider URL, method, exact command). Value-blind: checks only whether env vars are set and never reads or returns values. Use it after plan_clone to see what a clone would leave degraded; pair it with run_auth_flow to act on one credential.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetYesThe machine to operate on: this host (local) or a remote host over SSH (ssh).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetYesLabel of the inspected target.
missingYesCredential names not present.
presentYesCredential names already present on the target.
templateYesPath of the env file to fill in.
credentialsYesEvery credential the profile references with its acquisition guidance.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly/idempotent/openWorld, but the description adds the crucial non-obvious trait 'Value-blind: checks only whether env vars are set and never reads or returns values.' This is behavioral context the structured fields cannot convey, plus what output to expect (label, purpose, provider URL, method, command).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three dense sentences, front-loaded with the core action, then the key non-obvious constraint (value-blind), then usage guidance. No filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only inspection tool with annotations, an output schema, and full schema coverage, the description covers everything an agent needs: result contents, the safety-critical value-blind guarantee, and the workflow position (after plan_clone, alongside run_auth_flow).

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with rich nested descriptions (mode, host, port, user, identityFile, cwd), so the schema already handles parameter semantics. The description adds only implicit context about 'the profile' and 'the target,' which is marginal but slightly helpful.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a precise verb+resource: it lists required credentials plus their present/missing status and acquisition details. The parenthetical enumerates exactly what is returned, so an agent can distinguish it from siblings like run_auth_flow (which acts on a credential) or plan_clone (which plans the clone).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit when-to-use ('after plan_clone to see what a clone would leave degraded') and names the pairing tool ('pair it with run_auth_flow to act on one credential'), giving both the trigger and the follow-up action.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.