Skip to main content
Glama

ShearQuery — Barber & Beauty Industry Data

Add a note to a deal

crm_add_note

Add a note to a deal — what was said on a call, what they asked for, when to follow up.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteYes
opportunity_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3/5.0
Behavior3/5

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

Annotations already establish that this is a non-readonly, non-idempotent, non-destructive, closed-world write. The description adds useful context about what a note is meant to capture, but says nothing about permissions, persistence, or effects on the deal record — modest value beyond structured fields.

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?

A single front-loaded sentence with no filler; the verb and resource lead and the examples trail. Efficient, though the examples are arguably content-flavor rather than necessary detail.

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 simple two-parameter note-creation tool with an existing safety profile in annotations and no output schema, the intent is adequately conveyed. The missing piece is any handling of the deal identifier and confirmation of what calling it changes.

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

Parameters2/5

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

Schema description coverage is 0%, so both parameters rely on the description. It clarifies the intended content of 'note' (what was said, requests, follow-up timing) but gives no guidance on 'opportunity_id' format or how to obtain a valid deal id — a partial, not full, compensation for the coverage gap.

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 states a specific verb and resource: 'Add a note to a deal.' That is unambiguous and distinguishable from the other crm_* siblings (which operate on opportunities, pipelines, etc.), though it does not explicitly name or contrast with any sibling.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance, and no alternatives are named. The content examples hint at intended scenarios (call notes, follow-ups) but the agent gets no routing logic.

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.