get_userid_config

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds context about reading a config path, which is useful but does not go beyond the annotation much. There is no contradiction between the 'READ-ONLY' label and the read-only annotations.

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?

The description is compact: one sentence of purpose and one of the config path. Every part adds information, and the read-only attribute is front-loaded for quick agent recognition.

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?

For a simple read-only tool with one optional parameter and no output schema, the description adequately explains what is retrieved and where from. It is slightly incomplete in not differentiating itself from the nearby User-ID mapping/group tools, but overall enough for correct invocation.

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?

The only parameter, 'firewall', already has a fully descriptive schema comment explaining it targets a firewall name and is optional unless multiple firewalls are configured. Since schema description coverage is 100%, the description does not need to add much, and it does not.

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?

The description clearly states a specific verb ('Retrieves') and a specific resource ('User-ID configuration settings'), and gives concrete detail about scope ('agent configuration and group mapping'). The config path helps distinguish it from read tools focused on live mappings or groups, though it does not explicitly name siblings.

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?

The description gives no guidance on when to choose this tool over related siblings like get_userid_mappings or get_userid_groups. There is no mention of exclusions, prerequisites, or alternative tools, so an agent must infer appropriate usage solely from the phrase 'configuration settings'.

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