set_stream_favorite

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

No annotations are provided, so the description carries the burden. It discloses the key behavioral trait that Packmate returns 200 even for non-existent stream IDs (no row updated). This is helpful, but it does not detail other behaviors like whether the operation is reversible or what happens on success when the stream exists.

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 extremely concise: two sentences. The first sentence states the purpose, the second provides a critical behavioral note. No wasted words or redundancy. It is well-structured and front-loaded.

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 that there is an output schema (not shown), the description does not explain the return value. It covers the basic purpose and an important edge case, but lacks full context like prerequisites, authentication, or expected output. For a simple mutation with two parameters, it is adequate but not complete.

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 description coverage is 0% as the input schema only has titles, no descriptions. The description does not explain the parameters beyond their names and the tool's global purpose. For instance, stream_id and favorite are not further clarified (e.g., which stream, what true/false means). The description adds minimal value over the schema.

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 'Mark or unmark a stream as favorite' clearly states the verb (mark/unmark) and resource (stream favorite status). It distinguishes from sibling tools like list_streams or get_stream that are read-only. However, it could be more precise about the effect (e.g., sets the favorite flag to the given boolean).

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 includes a note about the tool returning 200 even if the stream ID does not exist, which provides some usage context. However, it does not explicitly state when to use this tool versus alternatives or any prerequisites. Usage is implied by the action of setting a favorite.

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