query_profile

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

No annotations provided, so description carries burden. It describes pagination behavior (offset, limit, hasMore) and return structure (Page_Response). However, it does not explicitly state that the tool is read-only or whether it has side effects, though 'Query' implies read-only.

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?

Description is well-structured with clear sections (Args, Returns). It is concise, using code blocks for clarity, and front-loads the main purpose. Every sentence adds value, though the description of profiles could be shortened.

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?

Given no output schema, description includes return keys (items, total, offset, limit, hasMore). It covers all parameters and their usage. However, it lacks information on error conditions, required permissions, or how it differs from list_profiles, which is a sibling tool.

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?

Schema coverage is 0% but description adds significant value: explains that query_value is required for by_uuid, by_title, by_type queries; specifies offset/limit defaults and range (1-100). This goes beyond the schema which only provides enums and defaults.

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 'Query OSCAL Profile documents' and explains the purpose of profiles as baselines/overlays. It lists specific query types (all, by_uuid, by_title, by_type), distinguishing it from sibling tools like list_profiles which likely list without filtering.

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 explains when to use each query_type parameter (e.g., by_uuid requires query_value) but does not compare this tool to siblings like list_profiles or other query_* tools. It lacks explicit guidance on when not to use this tool or when alternatives are better.

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