Skip to main content
Glama

GetServiceDefinition

Retrieve RAP service definition source code and metadata by service name from SAP ABAP systems, enabling AI assistants to inspect and manage RAP definitions.

Instructions

Retrieve RAP service definition source code and metadata

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
service_nameYesName of the service definition

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.3/5.0
Behavior3/5

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

No annotations exist, so the description carries the full burden; it does disclose that both source code and metadata are returned, which is real behavioral value. However, it says nothing about authorization requirements, error behavior when the service does not exist, or the format of the returned source.

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?

A single front-loaded sentence that names the action, the resource, and the return content with no wasted words. Nothing is buried or redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter read tool with a fully documented schema this is close to adequate, and it does state what is returned. But with no output schema and no annotations, the absence of any detail on return format or failure modes leaves a noticeable gap.

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 single parameter is fully documented in the schema at 100% coverage, so the schema already does the work. The description adds no naming-convention or format guidance (e.g., package-qualified vs. plain name), so the baseline of 3 applies.

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?

States a specific verb (Retrieve) and resource (RAP service definition) and clarifies the payload is source code plus metadata. It distinguishes itself adequately from CreateServiceDefinition and GetServiceBinding by naming the artifact type, though it never explicitly contrasts with those siblings.

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

Usage Guidelines2/5

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

There is no guidance on when to use this versus GetServiceBinding, GetBehaviorDefinition, or the many other Get* siblings, and no prerequisites stated. Usage is only implied by the name and the read verb.

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