Skip to main content
Glama

Add a note to a job

kickserv_add_job_note
Destructive

WRITE: add a note to a job. Set public to true to make it visible to the customer. Kickserv: POST /{account}/jobs/{job_number}/notes.xml.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteYesNote text.
publicNoTrue to make the note public (customer-visible).
job_numberYesJob number.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations supply only destructiveHint=true; the description adds the mutation framing ('WRITE') and the endpoint (POST /jobs/{job_number}/notes.xml), plus the customer-visibility semantics of `public`. It does not cover auth/permission requirements or what the call returns, and it never reconciles why a note append carries a destructive hint.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences plus an endpoint, with the operation type front-loaded in 'WRITE:'. Nothing is padded, though the raw endpoint string is the least valuable element for an agent choosing or calling the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 3-parameter mutation with no output schema and sparse annotations, the description covers the core action and the one non-obvious flag. It leaves the return value (e.g., new note ID) and any permission constraints unaddressed, which is adequate but not complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so all three parameters are already documented, including the customer-visible meaning of `public`. The description restates the `public` semantics rather than adding new information, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource ('WRITE: add a note to a job'), which distinguishes it from the read-side sibling kickserv_list_job_notes. Differentiation from kickserv_add_customer_note is implicit in the object ('a job') rather than stated, so it stops just short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by the WRITE label and the object of the note, but there is no explicit when-to-use/when-not or reference to alternatives such as kickserv_add_customer_note. The `public` flag guidance is useful but is about a parameter, not about selecting this tool.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.