Get Record Comments

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

No annotations provided, but the description discloses per-call limit of 10 comments, pagination via offset, and the single-record nature. Output schema handles return structure. Could explicitly state read-only nature, but 'get' implies it.

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, no filler. First sentence states purpose, second explains API behavior and pagination. Efficient and front-loaded.

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?

With 5 parameters and an output schema, the description covers essential behavior: single record, pagination limit, and offset usage. Could mention error scenarios or default order, but not necessary for basic usage. Complete enough for an agent.

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?

Schema already covers all 5 parameters with descriptions. The description adds practical guidance: 'Up to 10 comments per call; use offset to paginate,' which clarifies how limit and offset work together.

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?

Clearly states the tool retrieves comments on a single kintone record. Distinct from siblings like kintone-add-record-comment (adds comments) and kintone-get-records (gets entire records).

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?

Explains that the tool works for one record at a time and suggests repeated calls for multiple records. Also explains pagination with offset. Lacks explicit mention of when not to use, but the context is clear.

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