pbs_realm_pam_get

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

Declares read-only with 'READ-ONLY' and a config prerequisite, but with no annotations, fails to mention authentication details, error cases, or scope of 'config'.

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

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

Two sentences, front-loaded with 'READ-ONLY', no redundant text; every word earns its place.

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

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

Adequate for a simple get tool with output schema, but lacks explanation of what 'config' includes or typical usage notes; no annotation burden but still minimal.

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

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

Only parameter is 'proximo_target' which is fully described in schema; description adds no further semantic value.

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

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

Description states verb 'get' and specific resource 'built-in PAM realm's config (comment/default only)', clearly distinguishing from sibling set and other realm tools.

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

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

Implies use for reading PAM realm config via 'READ-ONLY' and config requirement, but no explicit when-to-use, when-not, or alternatives like pbs_realm_pam_set.

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