Skip to main content
Glama

Pipeline summary

get_pipeline_summary
Read-only

Summarize opportunities by type/stage and pipeline_by_lens using stage roles, not labels. Stages include role and sales_boundary_stage (first active stage). pipeline_key/pipeline_id scopes only opportunity breakdowns; omit both for the default pipeline plus unassigned deals. Revenue (ARR/customer/at-risk counts), renewals and at-risk accounts remain workspace-wide. Renewals cover the next 90 days: totals include EVERY renewal; the list caps at 500 and coverage/truncated identify a sample. Forecast includes per-person rows, reporting-tree rollups, separate currencies, targets, human calls and supporting deal IDs. Nothing predicts.

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.

Input Schema

NameRequiredDescriptionDefault
pipeline_idNoScope the opportunity breakdowns to this pipeline by id (uuid). Prefer pipeline_key.
pipeline_keyNoScope 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.
forecast_periodNoCalendar forecast period in the workspace timezone; defaults to quarter.

Output Schema

NameRequiredDescriptionDefault
noteNo
emptyNo
stagesNo
revenueNo
forecastNo
frameworkNo
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. Changed1 schema field changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
  2. 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)$"
  3. 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"
      +]
  4. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Annotations already declare read-only/non-destructive, but the description adds materially new behavior: pipeline scoping applies only to opportunity breakdowns while revenue/renewals/at-risk stay workspace-wide, renewals cover a 90-day window where totals include every renewal but the list caps at 500 with coverage/truncated flags identifying a sample. It also preempts a likely misread with "Nothing predicts" and details forecast composition (per-person rows, tree rollups, separate currencies, targets, human calls, supporting deal IDs).

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?

Purpose, scoping rules, metric semantics, when-to-use and an example are laid out in a front-loaded order with little filler. It is dense and slightly run-on, and the one-line example adds marginal value, but each sentence carries a distinct constraint.

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?

Given an output schema exists, the description need not enumerate return fields, yet it covers exactly the non-obvious behaviors an agent would otherwise get wrong: scoping asymmetry, the 90-day renewal window, the 500-item list cap with truncation signaling, and forecast row composition. Nothing material is missing for correct invocation.

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 100%, so the schema baseline already documents all three parameters. The description still adds meaning beyond it by clarifying that pipeline_key/pipeline_id scope only the opportunity breakdowns, that omitting both yields the default pipeline plus unassigned deals, and that other metrics remain workspace-wide.

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 opening sentence names a specific verb+resource and even the mechanism ("Summarize opportunities by type/stage and pipeline_by_lens using stage roles, not labels"), and it lists the concrete payload (revenue, renewals, forecast). It does not explicitly name the sibling it competes with (e.g., run_report or show_report), so an agent must infer the boundary from the "not vague data exploration" caveat.

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 explicit "When to use" line gives both inclusion criteria (sales workspace with opportunities, forecast/renewals/ARR questions) and exclusions ("not vague data exploration or before motion setup"). It stops short of naming the alternative tool to pick when the conditions fail, which keeps it below a 5.

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