profilarr_get_announcement

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

The readOnlyHint annotation already establishes this is a safe read operation. The description adds value by specifying that the response includes the markdown body, which is a behavioral detail beyond the annotation. No contradiction exists, and the additional context is useful.

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 a single, concise sentence of 13 words. It is front-loaded with the key action and resource, includes no fluff, and every word adds meaning.

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 get tool with one parameter and an output schema, the description is complete. It states what to retrieve and highlights the markdown body. Sibling tools provide additional context for source of ids, and the output schema covers return structure, so no significant gaps exist.

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?

With 0% schema description coverage, the description must compensate. It clarifies that the 'id' parameter is an announcement identifier ('by id'), but does not explain the id's origin, format, or how to obtain it (e.g., from list_announcements). This is minimal compensation, warranting a mid-range score.

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 verb 'Get' and the resource 'a single announcement by id', explicitly distinguishing this from the sibling tool 'profilarr_list_announcements' which lists announcements. It also notes the markdown body, making the purpose specific and unambiguous.

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 implies usage: when you need a single announcement by its id. It sets clear context (id required) but does not explicitly mention when not to use it or point to alternatives like list_announcements for retrieving multiple announcements. This is acceptable but not fully explicit.

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