list_releasesList Yappy release history for macOS, newest first, with the version, publication date, and what changed in each. Use this to answer questions about what shipped recently or when a particular fix landed.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many releases to return, newest first. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover read-only, open-world, idempotent, and non-destructive behavior. The description adds that results are newest first and include specific fields, providing helpful expectations for the response. This goes beyond annotations without contradicting them.
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?
Two sentences with no fluff. The first sentence front-loads the core purpose and scope, the second gives usage guidance. Every word earns its place.
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 list tool with one optional parameter, the description covers purpose, scope, ordering, and returned fields. The only minor gap is no mention of pagination beyond the limit, but the schema's default and max cover that. Complete enough for an agent to call correctly.
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 fully documents the limit parameter with type, default, min, max, and description (100% coverage). The description does not add extra meaning to the parameter, but that is not necessary given the schema's completeness. Baseline 3 is appropriate.
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 states a specific verb (List), a resource (Yappy release history for macOS), and the content returned (version, publication date, and changes). It clearly distinguishes from the sibling get_latest_release by covering history rather than just the latest release.
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 explicit usage guidance: 'Use this to answer questions about what shipped recently or when a particular fix landed.' It does not explicitly name the alternative get_latest_release, but the usage context implies when this tool is appropriate, so the guidance is clear but lacks explicit exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool targets a clearly distinct piece of information or action: compatibility checks, system requirements, pricing, features, FAQ, releases, and export jobs. Even the pair check_mac_compatibility and get_system_requirements is separated by one asking for a decision about a specific Mac and the other returning raw requirements.
Tool names consistently follow a verb_noun pattern using get_, list_, create_, and check_. Singular nouns pair with single-item resources and plural nouns with collection endpoints, making the set predictable.
Nine tools is well-scoped for a product information and export server. Each tool covers a meaningful part of the surface without redundancy or padding.
The tool set covers the full likely question space for the Yappy app: compatibility, requirements, pricing, features, FAQ, latest release, release history, and bulk corpus export. The async export pair provides a complete path to documentation content without leaving dead ends.