Skip to main content
Glama

Pipeline summary

get_pipeline_summary
Read-only

Summarize opportunities by type/stage and stage-role lens; sales_boundary_stage is the first active stage. Pipeline filters scope only opportunities; revenue, renewals and at-risk accounts stay workspace-wide. forecast_period scopes only forecast; other breakdowns include all close dates. Forecast has people/team rollups, currencies, targets, human calls and deal IDs; nothing predicts. Renewal totals cover every renewal due in 90 days, not just at-risk accounts; subscriptions caps at 500 (see coverage).

When to use: Sales pipeline, forecast, renewals or ARR in a sales workspace with opportunities; not vague data exploration or before motion setup.

Example: Summarize my pipeline.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_pipeline_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
pipeline_idNoPipeline UUID; overrides pipeline_key.
pipeline_keyNoStable key from describe_schema. Omit both filters for the default pipeline plus unassigned deals.
forecast_periodNoForecast only; workspace calendar/timezone. Default: quarter.

Output Schema

NameRequiredDescriptionDefault
noteNo
emptyNo
scopeNo
stagesNo
revenueNo
forecastNo
guidanceNo
frameworkNo
open_by_typeNo
pipeline_by_lensNo
total_opportunitiesNo
sales_boundary_stageNo
renewals_due_next_90_daysNo
pipeline_by_type_and_stageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / renewals_due_next_90_days / properties / arr_at_risk_note
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / renewals_due_next_90_days / properties / flagged_renewal_arr_cents
      Added value: +{
      +  "type": "null"
      +}
  2. Changed1 schema field changed
    • addedOutput schema / properties / open_by_type
      Added value: +{
      +  "type": "object"
      +}
  3. Changed12 schema fields changed
    • changedInput schema / properties / forecast_period / description
      Previous value: -"Calendar forecast period in the workspace timezone; defaults to quarter."New value: +"Forecast only; workspace calendar/timezone. Default: quarter."
    • changedInput schema / properties / pipeline_id / description
      Previous value: -"Scope the opportunity breakdowns to this pipeline by id (uuid). Prefer pipeline_key."New value: +"Pipeline UUID; overrides pipeline_key."
    • changedInput schema / properties / pipeline_key / description
      Previous value: -"Scope the opportunity breakdowns to this pipeline by its stable KEY (see the `pipelines` section / describe_schema). Omit both for the default pipeline + unassigned deals (today's behavior). pipeline_id wins if both are given."New value: +"Stable key from describe_schema. Omit both filters for the default pipeline plus unassigned deals."
    • addedOutput schema / properties / guidance
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / properties / renewals_due_next_90_days / properties / arr_at_risk_cents / description
      Previous value: -"mrr_cents × 12 summed over every renewal due, computed in SQL."New value: +"Compatibility alias of arr_up_for_renewal_cents."
    • addedOutput schema / properties / renewals_due_next_90_days / properties / arr_up_for_renewal_cents
      Added value: +{
      +  "description": "ARR of all due renewals, not an at-risk filter.",
      +  "maximum": 9007199254740991,
      +  "minimum": -9007199254740991,
      +  "type": "integer"
      +}
    • addedOutput schema / properties / renewals_due_next_90_days / properties / arr_up_for_renewal_display
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / properties / renewals_due_next_90_days / properties / count / description
      Previous value: -"Every renewal due, counted in SQL — never limited by the list cap."New value: +"All due renewals, before the list cap."
    • removedOutput schema / properties / renewals_due_next_90_days / properties / coverage / description
      Removed value: -"The list's coverage: returned rows of the total due, in the search_coverage shape."
    • changedOutput schema / properties / renewals_due_next_90_days / properties / subscriptions / description
      Previous value: -"Up to 500 renewals, soonest first; a sample when coverage is truncated."New value: +"Soonest first, at most 500."
    • removedOutput schema / properties / renewals_due_next_90_days / properties / truncated / description
      Removed value: -"True when more renewals are due than the 500-row list holds."
    • addedOutput schema / properties / scope
      Added value: +{
      +  "additionalProperties": {
      +    "type": "string"
      +  },
      +  "type": "object"
      +}
  4. Changed1 schema field changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
  5. Changed1 schema field changed
    • removedInput schema / properties / pipeline_id / pattern
      Removed value: -"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
  6. Changed16 schema fields changed
    • removedOutput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • removedOutput schema / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / forecast / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / forecast / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / framework / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / framework / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / pipeline_by_lens / additionalProperties / additionalProperties
      Removed value: -false
    • removedOutput schema / properties / pipeline_by_lens / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / pipeline_by_type_and_stage / additionalProperties / additionalProperties / additionalProperties
      Removed value: -false
    • removedOutput schema / properties / pipeline_by_type_and_stage / additionalProperties / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / pipeline_by_type_and_stage / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / renewals_due_next_90_days / additionalProperties
      Removed value: -false
    • removedOutput schema / properties / renewals_due_next_90_days / properties / coverage / additionalProperties
      Removed value: -false
    • removedOutput schema / properties / revenue / additionalProperties
      Removed value: -false
    • removedOutput schema / properties / sales_boundary_stage / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / sales_boundary_stage / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  7. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Well beyond the readOnlyHint annotation, it discloses non-obvious scoping rules: pipeline filters affect only opportunities while revenue, renewals and at-risk stay workspace-wide, and forecast_period scopes only forecast while other breakdowns span all close dates. It also flags limits and coverage caveats (subscriptions capped at 500, renewals cover every renewal due in 90 days regardless of at-risk) and states that nothing is predicted, which guards against a plausible misinterpretation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

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

The opening sentence is a dense semicolon chain that front-loads subtle scoping caveats before the agent has read the primary action, making it harder to parse than the tool's actual simplicity warrants. All the content is relevant, but the packing order and punctuation density reduce readability.

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?

With an output schema present, return-value shape need not be described, and the description still covers aggregation dimensions, filter scope interactions, caps and the no-prediction caveat. It stops short of stating whether results are paginated or how coverage limits surface, though the reference to '(see coverage)' points at where that lives.

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

Parameters4/5

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

Schema coverage is already 100%, so baseline is 3, and the description earns above that by explaining the blast radius of each filter rather than restating it — pipeline filters do not narrow revenue/renewals, and forecast_period does not narrow the other breakdowns. Default behavior for omitting pipeline filters is documented in the schema rather than the description, but the cross-filter interactions are genuine added meaning.

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?

It opens with a concrete verb and resource: summarize opportunities by type/stage through a stage-role lens, and it enumerates the sub-areas covered (forecast, renewals, ARR, subscriptions). The domain boundary is explicit via 'sales workspace with opportunities', but it never names a sibling tool, so differentiation from other reporting or schema tools is left to inference.

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?

The 'When to use' line gives positive conditions plus explicit exclusions ('not vague data exploration or before motion setup') and an example phrasing. What is missing is any named alternative tool for those excluded cases, so the agent knows when not to use it but not where to go instead.

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