getSettingsOnboarding

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

With no annotations, the description carries behavioral disclosure and does include read-only semantics, the HTTP GET method, and a rate limit of 100 requests per 1m. It does not describe the shape or possible values of onboarding status, but core non-obvious behavior is covered.

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 one compact, front-loaded sentence; it places the purpose first and includes the useful endpoint and rate-limit in parentheticals without redundancy.

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 parameterless GET endpoint, the description is nearly complete: it provides endpoint, read-only nature, and rate limit. The only minor gap is not defining what an onboarding status value looks like, but this does not impede correct invocation.

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?

There are zero required or optional parameters and the input schema is empty, so the description has no parameter details to compensate for. Baseline 4 is appropriate because no parameter ambiguity exists.

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?

Description states a specific verb+resource: 'Get onboarding status', and reinforces it with the endpoint path '/postframe/settings/onboarding', which distinguishes it from generic siblings like getSettings and getMerchantSettings.

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 guidance is given about when to choose this tool over alternatives, no exclusions, and no relationship to getSettings or other settings endpoints. Usage is only implied by the verb, not explained.

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