get_component_structure

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

No annotations provided; description adds some context (returns pages, records, navigation) but does not disclose authentication, performance, or other behavioral traits. Adequate for a simple get operation.

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?

Extremely concise with a clear purpose statement, separated Args and Returns sections. No wasted text.

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 one-parameter tool without output schema, the description adequately covers what the tool returns and the parameter. Could mention ordering or more detail on navigation path, but completes the needed context.

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 schema has 0% description coverage, but the description provides examples and clarifies the parameter is a component name. This adds significant meaning beyond the schema, though constraints like case sensitivity are missing.

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 the tool retrieves the structure of a PeopleSoft component including pages, records, and navigation path. This distinguishes it from siblings like get_component_pages and describe_table.

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?

No explicit when to use or when not to use. The description implies this tool is for full component structure, while siblings like get_component_pages exist for pages only, but no direct guidance.

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