Skip to main content
Glama

Get one SAP Cloud ALM entity

calm_get
Read-only

Fetch a single SAP Cloud ALM entity by resource and ID, and limit returned fields for large objects to keep responses small.

Instructions

Fetch a single SAP Cloud ALM entity by id (a feature can also be fetched by display id like "6-123"). Choose a "resource" and pass its "id". See calm_resources for valid ones. A task has ~70 fields: pass fields="displayId,title,status,..." to keep the answer small.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesEntity id (uuid, REST id, or feature display id like "6-123")
expandNoOData $expand for OData entities; REST entities reject it
fieldsNoComma-separated fields to keep, e.g. "displayId,title,status". Use it for large entities such as tasks; an unknown name is rejected with the available ones
resourceYesWhich single entity to fetch (see calm_resources)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.9.1
    • addedInput schema / properties / fields
      Added value: +{
      +  "description": "Comma-separated fields to keep, e.g. \"displayId,title,status\". Use it for large entities such as tasks; an unknown name is rejected with the available ones",
      +  "type": "string"
      +}
    • addedInput schema / properties / id / pattern
      Added value: +"^(?!\\.\\.?$).+$"
  2. Changed1 schema field changedv0.9.0
    • changedInput schema / properties / expand / description
      Previous value: -"OData $expand for OData entities"New value: +"OData $expand for OData entities; REST entities reject it"
  3. Changed1 schema field changedv0.2.0
    • changedInput schema / properties / resource / enum
      Previous value: -[
      -  "feature",
      -  "document",
      -  "hierarchy_node",
      -  "manual_test_case",
      -  "automated_test_case",
      -  "xlib_application",
      -  "xlib_configuration",
      -  "xlib_development",
      -  "xlib_interface",
      -  "task",
      -  "deliverable",
      -  "project",
      -  "program",
      -  "timebox",
      -  "team",
      -  "deployment_plan",
      -  "system_group"
      -]New value: +[
      +  "feature",
      +  "document",
      +  "hierarchy_node",
      +  "manual_test_case",
      +  "automated_test_case",
      +  "xlib_application",
      +  "xlib_configuration",
      +  "xlib_development",
      +  "xlib_interface",
      +  "task",
      +  "deliverable",
      +  "project",
      +  "program",
      +  "timebox",
      +  "team",
      +  "deployment_plan",
      +  "system_group",
      +  "program_team",
      +  "scope",
      +  "solution_scenario_version",
      +  "business_process",
      +  "solution_process",
      +  "solution_activity",
      +  "process_asset",
      +  "test_plan",
      +  "test_case_assignment"
      +]
  4. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already establish read-only, open-world behavior. The description adds useful context: features can be fetched by display id, tasks have ~70 fields, and passing fields keeps responses small. It also notes that unknown field names are rejected with available ones, going beyond the structured annotations.

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?

The description is front-loaded and compact: purpose first, then resource selection, then field guidance. Every sentence serves a purpose, though the field example duplicates schema text slightly and the description stops short of a fully tight three-sentence package.

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 get-by-id tool with a rich enum schema and read-only annotations, the description covers the essential call pattern, resource selection, and large-entity field handling. It does not explain return shape or missing-id behavior, but no output schema exists and the 'fetch a single entity' framing implies the return adequately.

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 the baseline is 3. The description largely repeats what the schema already provides for id, resource, and fields, adding little syntax or meaning beyond the structured parameter documentation.

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?

The description states a specific verb (Fetch) and resource (single SAP Cloud ALM entity), and distinguishes itself from listing siblings by emphasizing 'single' and retrieval by id. It also highlights the special display-id case and field selection, making the action unambiguous.

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

Usage Guidelines3/5

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

It tells the agent to choose a resource and pass an id, and points to calm_resources for valid values, which implies usage. However, it never says when to use this tool instead of calm_list or calm_analytics, nor does it state any exclusions or prerequisites beyond the resource lookup.

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