Skip to main content
Glama

get_data_entity_info

Read-onlyIdempotent

WHEN: developer building an OData / DMF integration needs a quick rundown of a specific data entity: its public OData name, datasources, key fields, and IsPublic status. Triggers: 'data entity info', 'OData entity details', 'is X a public entity', 'entity datasources'. Cloud-safe: pure metadata read from the KB.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entityNameYesData entity name (AxDataEntityView), e.g. 'CustCustomerV3Entity', 'SalesOrderHeaderV2Entity'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds value beyond those by specifying 'Cloud-safe: pure metadata read from the KB', which tells the agent the operation touches no business data and which source backs it. No contradiction with 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 compact and well-organized: purpose first, then triggers, then safety. Each labeled segment earns its place. The trigger phrase list is slightly verbose but functional for intent matching rather than padding.

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 single-parameter, fully schema-documented, annotation-backed read tool, the description is nearly complete. It compensates for the absent output schema by stating what fields the rundown includes. Minor gaps remain: exact-match behavior for entityName and not-found handling are not mentioned.

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%; the schema already explains entityName with the AxDataEntityView naming convention and concrete examples. The description adds no new parameter-level meaning, so the baseline 3 applies.

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 opens with a specific verb and resource: 'getting a quick rundown of a specific data entity' for OData/DMF integration, and enumerates exactly what is returned (public OData name, datasources, key fields, IsPublic status). This clearly distinguishes it from related siblings like get_object_details, find_entity_for_table, and list_objects.

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' clause gives concrete context (building an OData/DMF integration, needing a quick entity rundown) and explicit trigger phrases ('data entity info', 'OData entity details', 'is X a public entity') that help an agent match intents. It lacks explicit when-not-to-use guidance or named alternatives, which keeps it a step below 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.