Skip to main content
Glama

List Deals

list_deals
Read-only

List the Deals you can see in this Workspace, one page at a time. Use it to filter by open or closed, stage, owner or expected close date, or to sort; use search to find one by name, and get_deal for its Contacts. Returns rows with stage, amount and Company, plus the total. Needs the Deals module: without it, PRECONDITION_FAILED.

Input Schema

NameRequiredDescriptionDefault
qNoMatches the Deal's or its Company's name. Empty returns every Deal you can see.
dirNoSort direction.asc
pageNoPage number, from 1.
sortNoOne of name, company, stage, amount, expectedCloseDate, createdAt, owner or lastActivity. Empty or unknown sorts newest first.
ownerNoA user id or "all".all
stageNoDEMO_BOOKED, QUALIFIED_TO_BUY, UNQUALIFIED_TO_BUY, DECISION_MAKER_BOUGHT_IN, CONTRACT_SENT, CLOSED_WON, CLOSED_LOST or "all".all
statusNo"open", "closed" or "all". A stage filter overrides it.all
closingNoExpected close date: overdue, this-month, next-month, later, none or "all".all
pageSizeNoRows per page, up to 100.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changed
    • addedInput schema / properties / closing / description
      Added value: +"Expected close date: overdue, this-month, next-month, later, none or \"all\"."
    • addedInput schema / properties / dir / description
      Added value: +"Sort direction."
    • addedInput schema / properties / owner / description
      Added value: +"A user id or \"all\"."
    • addedInput schema / properties / page / description
      Added value: +"Page number, from 1."
    • addedInput schema / properties / pageSize / description
      Added value: +"Rows per page, up to 100."
    • addedInput schema / properties / q / description
      Added value: +"Matches the Deal's or its Company's name. Empty returns every Deal you can see."
    • addedInput schema / properties / sort / description
      Added value: +"One of name, company, stage, amount, expectedCloseDate, createdAt, owner or lastActivity. Empty or unknown sorts newest first."
    • addedInput schema / properties / stage / description
      Added value: +"DEMO_BOOKED, QUALIFIED_TO_BUY, UNQUALIFIED_TO_BUY, DECISION_MAKER_BOUGHT_IN, CONTRACT_SENT, CLOSED_WON, CLOSED_LOST or \"all\"."
    • addedInput schema / properties / status / description
      Added value: +"\"open\", \"closed\" or \"all\". A stage filter overrides it."
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description still adds real context beyond them: pagination semantics ("one page at a time"), the returned row shape with a total, and a concrete failure mode (PRECONDITION_FAILED when the Deals module is absent). It does not mention permission scoping or rate limits, so not 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.

Conciseness5/5

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

Three tight sentences: capability first, routing second, return shape and precondition last. Every clause carries information and nothing is repeated from the schema verbatim.

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

Completeness5/5

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

For a nine-parameter read-only list tool with full schema coverage and no output schema, the description supplies what the schema cannot: the paginated contract, the returned fields, and the module prerequisite error. An agent has everything needed to call it correctly.

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 description coverage is 100%, so every one of the nine parameters (q, dir, page, sort, owner, stage, status, closing, pageSize) is already documented in the schema, including the enum values and defaults. The description only restates the filter categories at a high level and adds no syntax or interaction detail (e.g. that a stage filter overrides status). 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 and resource ("List the Deals you can see in this Workspace") plus a scope qualifier (workspace-visible, paginated). It explicitly distinguishes itself from the search sibling and from get_deal, so an agent can identify it without opening the schema.

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

Usage Guidelines5/5

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

Names concrete use cases (filter by open/closed, stage, owner, expected close date, or sort) and routes to alternatives with conditions: "use search to find one by name, and get_deal for its Contacts." Both when-to-use and when-not-to-use are covered.

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