Skip to main content
Glama

Query SAP Cloud ALM analytics

calm_analytics
Read-only

Count and break down SAP Cloud ALM records across the tenant by querying analytics providers; use count_only for totals or group_by for status/project breakdowns.

Instructions

Query an SAP Cloud ALM analytics provider (Defects, Tasks, Tests, Features, Projects, Metrics, ...). Supports $filter, and aggregates: it is the tool for tenant-wide totals and breakdowns. It does NOT sort — $orderby is ignored, so sort the records yourself. Every provider spans the whole tenant, so this is how you count without naming a project: count_only=true for a total, group_by="status" for a breakdown (Defects: "defectStatus"). Tasks covers user stories, defects and requirements; filter them by type CODE, e.g. filter="typeID eq 'CALMUS'" (the type text is silently ignored).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "provider": "<provider>"
    },
    "name": "calm_analytics"
  }
}

Input Schema

NameRequiredDescriptionDefault
topNoMaximum number of records (page size)
skipNoRecords to skip (page offset)
filterNoOData $filter, e.g. "status eq 'CIPDFCTOPEN'"
periodNoAnalytics time window, sent inside $filter. Format <L|C><n><H|D|W|M|Y>, e.g. "L1D" (last day) or "C1M" (current month). Counting defaults to "C1D" so each record is counted once
selectNoOData $select — comma-separated field list
group_byNoComma-separated field name(s) to break the count down by, e.g. "status" or "projectName,status". Returns {total, groups:[{value,count}]} instead of records. Also the quickest way to discover which values a field actually takes
providerYesAnalytics provider (e.g. Defects, Tasks, Tests). Every provider spans the whole tenant, so this is the only way to count without naming a project. It aggregates but does not sort: the service ignores $orderby, so never present its output as sorted
count_onlyNoReturn ONLY the total number of matching records, no records at all. Use this for every "how many ...?" question — the answer is a few hundred bytes instead of hundreds of KB. Works for every resource and provider
resolutionNoAnalytics bucket size, sent inside $filter: D, W, M or Y. A record appears once per bucket, so a wide window with a small bucket multiplies the count. Counting defaults to "D"
with_countNoReturn the total as "@count" ALONGSIDE the records (OData resources and analytics only). For a total without the records, use count_only instead
group_limitNoMaximum groups returned by group_by (default 50); the rest fold into otherCount

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.0.0
    • removedInput schema / properties / count
      Removed value: -{
      -  "description": "Return the total as \"@count\" ALONGSIDE the records (OData resources and analytics only). For a total without the records, use count_only instead",
      -  "type": "boolean"
      -}
    • changedInput schema / properties / skip / description
      Previous value: -"OData $skip — records to skip"New value: +"Records to skip (page offset)"
    • changedInput schema / properties / top / description
      Previous value: -"OData $top — maximum number of records"New value: +"Maximum number of records (page size)"
    • addedInput schema / properties / with_count
      Added value: +{
      +  "description": "Return the total as \"@count\" ALONGSIDE the records (OData resources and analytics only). For a total without the records, use count_only instead",
      +  "type": "boolean"
      +}
  2. Changed3 schema fields changedv0.9.2
    • addedInput schema / properties / group_limit / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / skip / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / top / maximum
      Added value: +9007199254740991
  3. Changed8 schema fields changedv0.9.0
    • addedInput schema / properties / count
      Added value: +{
      +  "description": "Return the total as \"@count\" ALONGSIDE the records (OData resources and analytics only). For a total without the records, use count_only instead",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / count_only
      Added value: +{
      +  "description": "Return ONLY the total number of matching records, no records at all. Use this for every \"how many ...?\" question — the answer is a few hundred bytes instead of hundreds of KB. Works for every resource and provider",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / group_by
      Added value: +{
      +  "description": "Comma-separated field name(s) to break the count down by, e.g. \"status\" or \"projectName,status\". Returns {total, groups:[{value,count}]} instead of records. Also the quickest way to discover which values a field actually takes",
      +  "type": "string"
      +}
    • addedInput schema / properties / group_limit
      Added value: +{
      +  "description": "Maximum groups returned by group_by (default 50); the rest fold into otherCount",
      +  "exclusiveMinimum": 0,
      +  "type": "integer"
      +}
    • removedInput schema / properties / orderby
      Removed value: -{
      -  "description": "OData $orderby, e.g. \"priority desc\" (OData resources / analytics only)",
      -  "type": "string"
      -}
    • addedInput schema / properties / period
      Added value: +{
      +  "description": "Analytics time window, sent inside $filter. Format <L|C><n><H|D|W|M|Y>, e.g. \"L1D\" (last day) or \"C1M\" (current month). Counting defaults to \"C1D\" so each record is counted once",
      +  "type": "string"
      +}
    • changedInput schema / properties / provider / description
      Previous value: -"Analytics provider (e.g. Defects, Tasks, Tests). Supports $orderby."New value: +"Analytics provider (e.g. Defects, Tasks, Tests). Every provider spans the whole tenant, so this is the only way to count without naming a project. It aggregates but does not sort: the service ignores $orderby, so never present its output as sorted"
    • addedInput schema / properties / resolution
      Added value: +{
      +  "description": "Analytics bucket size, sent inside $filter: D, W, M or Y. A record appears once per bucket, so a wide window with a small bucket multiplies the count. Counting defaults to \"D\"",
      +  "type": "string"
      +}
  4. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations cover the read-only profile, and the description adds genuinely non-obvious behavior: it does not sort, every provider spans the whole tenant, the type text filter is silently ignored (a silent-failure trap), and bucket/resolution multiplies counts. Missing only a note on default page size / cost of large top values.

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?

Front-loaded with the core purpose, then the counting/breakdown workflow, then caveats. Dense but every sentence carries an operational fact; only mild duplication with the provider enum description's tenant-wide/aggregation note.

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?

With 11 parameters and no output schema, the description still tells the agent what output shapes to expect (records vs total vs grouped counts) and flags the counting pitfalls (counting defaults to C1D, bucket multiplication, group_limit folding into otherCount). Enough to invoke correctly for the common analytics tasks.

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 baseline is 3; the description earns above that by explaining what group_by returns ({total, groups:[{value,count}]}) and mapping intent to parameters (count_only for "how many", group_by for value discovery, provider-specific field names like "defectStatus"). It leaves top/skip/select/period/resolution to the schema, which documents them adequately.

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?

Names a specific verb and resource ("Query an SAP Cloud ALM analytics provider") and enumerates the provider families (Defects, Tasks, Tests, Features, Projects, Metrics). Crucially it carves out its role versus the record-oriented siblings: "it is the tool for tenant-wide totals and breakdowns", so an agent can tell it apart from calm_list/calm_get 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 Guidelines5/5

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

Explicit routing rules: count_only=true for totals, group_by="status" for breakdowns, count_only instead of with_count when records aren't needed, and filter by type CODE ("typeID eq 'CALMUS'") for Tasks. It also states a negative: $orderby is ignored, so the agent must sort client-side.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools