List a job's notes
kickserv_list_job_notesList the notes on one job. Kickserv: GET /{account}/jobs/{job_number}/notes.xml.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_number | Yes | Job number. |
kickserv_list_job_notesList the notes on one job. Kickserv: GET /{account}/jobs/{job_number}/notes.xml.
| Name | Required | Description | Default |
|---|---|---|---|
| job_number | Yes | Job number. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already establishes this as a safe read, lowering the burden. The description adds the underlying endpoint (GET .../notes.xml), which usefully signals an XML response, but it says nothing about pagination, volume, or ordering.
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 short sentences, front-loaded with the purpose before the API detail. The endpoint sentence is arguably redundant but does carry format information, so it 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 one-parameter read-only listing tool with annotations covering safety, this is largely complete, and the .xml hint partly compensates for the absent output schema. Return shape and pagination behavior remain undocumented.
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?
With a single parameter at 100% schema description coverage, the schema already documents job_number fully. The description's 'one job' confirms the identifier but adds no syntax, range, or lookup detail 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 states a specific verb ('List') and resource ('the notes on one job'), scoping the operation to a single job. It is distinguishable from kickserv_add_job_note (write) and kickserv_list_customer_notes (different owner), though it never names those siblings to sharpen the distinction.
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?
There is no guidance on when to use this versus kickserv_list_customer_notes or other listing tools, and no stated prerequisites or exclusions. Usage is only implied by the phrase 'notes on one job'.
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.