Skip to main content
Glama
sap-odata-mcp

sap-odata-mcp

by asherwalden

Describe an SAP entity set

sap_describe_entity_set
Read-only

Retrieve fields, types, labels, keys, and navigation properties for an SAP OData entity set so you can build $filter or $select queries with real field names.

Instructions

Return the fields (name, type, label), keys and navigation properties of an entity set, from the service $metadata. Call this before building a $filter or $select so you use real field names.

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": {
      "service": "<service>",
      "entitySet": "<entitySet>"
    },
    "name": "sap_describe_entity_set"
  }
}

Input Schema

NameRequiredDescriptionDefault
serviceYesService name, e.g. API_SALES_ORDER_SRV
entitySetYesEntity set name, e.g. A_SalesOrder

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so safety is covered. The description contributes real behavioral context by identifying $metadata as the source of truth, which tells the agent the output reflects the live service definition and justifies the pre-flight workflow; it omits what happens on an invalid service or entity set name.

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?

Two sentences, both front-loaded: the first states the return payload, the second states the workflow constraint. Nothing is redundant and the most important detail (the returned fields) leads.

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?

There is no output schema, so the description must describe return values, and it does so precisely (field name, type, label, keys, navigation properties). Combined with the clear pre-use guidance and full schema coverage, 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?

The schema already documents both parameters at 100% coverage with concrete examples (API_SALES_ORDER_SRV, A_SalesOrder). The description adds no further meaning about service vs. entitySet semantics or their relationship, so the baseline 3 is appropriate.

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 description gives a specific verb ('Return') and resource ('an entity set') and enumerates exactly what comes back: fields with name/type/label, keys, and navigation properties, sourced from service $metadata. It separates itself from a query tool only indirectly through the workflow hint, never naming sap_query or sap_list_services.

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?

'Call this before building a $filter or $select so you use real field names' gives a clear, actionable trigger and the reason behind it. It stops short of stating when not to call it or naming the sibling tool that consumes the output, so it is strong but not fully exhaustive.

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