Skip to main content
Glama

Deal Read Tool

deal-read
Read-only

List or show sales deals. Multiple deals can belong to the same contact (user_id), including opportunities whose end-client is not known. List supports filters, sorting, pagination and an optional pipeline_id. Responses include visible pipeline card IDs for pipeline-item-write moves. Deal values require invoice access. Use deal-activity-read and deal-message-read with deal_id to read its activities and conversation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for "list". Default 1.
sortNoSort fields for "list". Append :asc or :desc for direction (default :asc). Example: ["created_at:desc"]. Available fields: id, user_id, company_id, owner_id, created_by, service_id, title, status, expected_close_date, closed_at, created_at, updated_at.
limitNoResults per page for "list". Default 20, max 100.
actionYesAction to perform.
deal_idNoDeal id. Required for "show" actions.
filtersNoPurity filter object for "list". Keys are field names, values are operator objects. Example: {"status":{"$eq":1}}. Available fields: id, user_id, company_id, owner_id, created_by, service_id, title, status, expected_close_date, closed_at, created_at, updated_at. Deal status values are open, won and lost. Monetary fields are not filterable or sortable.
pipeline_idNoFor list, restrict to deals on this visible sales pipeline.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered. The description adds genuinely non-obvious context: responses include visible pipeline card IDs usable by pipeline-item-write, and monetary values are access-gated by invoice permissions. No pagination limits or failure modes are described, keeping it short of a 5.

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?

Roughly four sentences, front-loaded with the verb/resource and then the cross-tool routing. Sentences are information-dense but slightly cramped, packing data-model, permissions, return values, and siblings together with no explicit separation.

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

Completeness4/5

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

For a read-only tool with full schema coverage and no output schema, the description covers the notable extras an agent needs: the parent/child relationship with contacts, the pipeline_id correlation to pipeline-item-write, and the invoice-access requirement for deal values. It omits return shape and pagination envelope details, but these are minor for a read tool.

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% and each parameter already carries its own description, sort syntax, and filter examples, so the schema does the heavy lifting. The description only reinforces that list supports filters, sorting, pagination and an optional pipeline_id, adding no syntax or semantics beyond the schema. Baseline 3 applies.

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

Purpose5/5

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

States a specific verb pair (list/show) on a named resource (sales deals) and clarifies the data model: multiple deals can belong to the same contact. An agent can distinguish this read tool from deal-write, deal-activity-read, and deal-message-read without opening schemas.

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

Usage Guidelines4/5

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

Explicitly routes activity and conversation reads to deal-activity-read and deal-message-read with deal_id, and notes deal values require invoice access. It does not explicitly state when to choose 'show' over 'list' beyond the schema's id requirement, so it falls short of full when/when-not guidance.

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.

Resources