Setell realized job margin

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

The description discloses key behaviors beyond annotations: the specific calculation method (revenue from payments, cost from price-book or labor rates), the conditional withholding of marginPct when data is insufficient, and the instruction to present UNKNOWN lines honestly. It also emphasizes the operator-only nature, adding value beyond the readOnlyHint.

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?

Every sentence contributes essential information: purpose, calculation logic, null handling, and confidentiality. The description is concise without redundancy, front-loading the core purpose and progressively detailing edge cases and warnings.

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 the lack of an output schema, the description adequately explains the key output behavior (marginPct may be null, lines may be UNKNOWN) and the calculation sources. However, it does not specify the exact output fields or structure, which could be clarified.

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 sole parameter jobId is documented in the schema with description. The tool description adds value by advising to find the job via setell_find_jobs or the setell://jobs resource, providing practical guidance beyond 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 clearly states the tool computes realized job margin, specifying that it uses revenue from payments and cost from price-book provenance. It distinguishes the tool by emphasizing 'realized margin' and operator-only data, making the purpose 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 does not explicitly guide when to use this tool versus its siblings (e.g., setell_get_margin_summary). It only provides usage-related warnings about not sharing data with customers but lacks when-to-use or when-not-to-use guidance.

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