Skip to main content
Glama

Get the AGENTS.md rules block for an ABAP repo

get_abap_agent_rules
Read-onlyIdempotent

Generate the ABAP section of AGENTS.md/CLAUDE.md to set coding-agent rules for ABAP repos: lint before commit, Cloud readiness, released APIs, scaffolding, and offline unit tests.

Instructions

Generate the ABAP section of a repository's AGENTS.md / CLAUDE.md: the lint-before-commit rule, the ABAP Cloud readiness gate, released-API discipline, scaffold-first, the offline unit-test loop, and the division of labour with an online ADT MCP server. Use this when you set up a new ABAP repo for agentic development or want a team's coding-agent rules to reference the abap-mcp tools consistently. It does not write the file (paste the returned markdown yourself), does not read the workspace, and is not a substitute for the project's own conventions — it encodes the tool contract, nothing project-specific beyond the parameters you pass. Example: { "target": "Cloud", "pairedWith": ["sap-adt-mcp"], "runEnabled": true }.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetNo"Cloud" (default) for ABAP Cloud / Steampunk repos, "classic" for on-prem baselines that still migrate.Cloud
editionNoReleased-API edition the readiness gate should quote: "s4hc" (S/4HANA Cloud Public Edition), "btp" (BTP ABAP Environment), "pce" (Private Cloud Edition).s4hc
pairedWithNoOnline ADT MCP servers the agent can also use: "sap-adt-mcp" (SAP official, ships with ADT), "abap-adt-mcp" (community), or "none".
runEnabledNoTrue when run_abap_unit is enabled (ABAP_MCP_ENABLE_RUN=1) so the rules prescribe the offline test loop.
packagePrefixNoCustomer namespace/prefix for new objects, e.g. "Z", "Y" or "/ACME/".Z

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
markdownYesThe AGENTS.md section, ready to paste.
ruleCountYesNumber of rules emitted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.12.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint=false, so safety is covered by structured data. The description adds real value beyond that by disclosing the non-obvious post-condition that the markdown is only returned and must be pasted by the caller, and that it encodes the tool contract rather than project-specific conventions.

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?

A single dense paragraph, but it is front-loaded with the artifact it produces and every clause afterwards carries distinct information (contents, when to use, exclusions, example). Slightly overlong, but no sentence is pure filler.

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 an output schema present the description needn't explain return values, and it still covers what is produced, the usage triggers, the boundaries, and an example invocation. For a zero-required-parameter generator, 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.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema documents each parameter's meaning, setting a baseline of 3. The description goes slightly further by giving a concrete example call ({ target: "Cloud", pairedWith: ["sap-adt-mcp"], runEnabled: true }) that shows how the settings combine, though edition and packagePrefix are not illustrated.

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?

States a specific verb (Generate) and a specific artifact (the ABAP section of AGENTS.md / CLAUDE.md), then enumerates its contents. No sibling in the list produces rules documentation, so the agent can distinguish it immediately from list_abap_rules / explain_abap_rule.

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?

Gives explicit trigger conditions ('when you set up a new ABAP repo for agentic development' or want team rules referencing abap-mcp tools) plus clear exclusions: it does not write the file, does not read the workspace, and is not a substitute for project conventions. Nothing is left to inference.

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