Skip to main content
Glama
ethanhan2014

SAP ADT MCP Server

by ethanhan2014

change_abap_class

Update the source code of an ABAP class in SAP. Locks the object, writes the new source, activates, and unlocks. Read the current source with get_class first.

Instructions

Modify an existing ABAP class in the SAP system. Locks the object, writes the new source, activates, and unlocks. Use get_class first to read the current source.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesClass name (e.g. ZCL_MY_CLASS)
sourceYesComplete new ABAP class source code including CLASS definition and IMPLEMENTATION.
system_idNoSAP system ID (e.g. DEV). Omit to use default system.

Implementation Reference

  • The `changeAbapClass` method on the AdtClient class handles the core execution logic for the 'change_abap_class' tool. It locks the class, writes the new source code (with auto-transport detection), unlocks, and activates the class.
      async changeAbapClass(name: string, source: string, transport?: string): Promise<string> {
        await this.fetchStatefulCsrf();
        const log: string[] = [];
        const nameLower = name.toLowerCase();
        const nameUpper = name.toUpperCase();
    
        try {
          // 1. Lock
          const lockResp = await this.http.post(
            `/sap/bc/adt/oo/classes/${nameLower}?_action=LOCK&accessMode=MODIFY`,
            "",
            { headers: this.statefulHeaders(), responseType: "text", validateStatus: () => true }
          );
          const lockData = lockResp.data as string;
          const lockMatch = lockData.match(/<LOCK_HANDLE>([^<]+)<\/LOCK_HANDLE>/);
    
          if (!lockMatch?.[1]) {
            log.push(`Failed to lock class ${nameUpper} (HTTP ${lockResp.status})`);
            log.push(lockData.substring(0, 500));
            return log.join("\n");
          }
    
          const lockHandle = lockMatch[1];
          log.push(`Locked ${nameUpper} for editing`);
    
          // 2. Write source (auto-detect transport if not provided)
          let corrNr = transport ?? "";
          let writeResp = await this.http.put(
            `/sap/bc/adt/oo/classes/${nameLower}/source/main?lockHandle=${encodeURIComponent(lockHandle)}&corrNr=${corrNr}`,
            source,
            {
              headers: this.statefulHeaders({ "Content-Type": "text/plain; charset=utf-8" }),
              responseType: "text",
              validateStatus: () => true,
            }
          );
          if (writeResp.status >= 400 && !transport) {
            const trMatch = (writeResp.data as string).match(/request\s+([A-Z]{3}K\d{6})/);
            if (trMatch) {
              corrNr = trMatch[1];
              log.push(`Auto-detected transport ${corrNr}`);
              writeResp = await this.http.put(
                `/sap/bc/adt/oo/classes/${nameLower}/source/main?lockHandle=${encodeURIComponent(lockHandle)}&corrNr=${corrNr}`,
                source,
                {
                  headers: this.statefulHeaders({ "Content-Type": "text/plain; charset=utf-8" }),
                  responseType: "text",
                  validateStatus: () => true,
                }
              );
            }
          }
          if (writeResp.status >= 400) {
            log.push(`Write failed (HTTP ${writeResp.status}): ${(writeResp.data as string).substring(0, 500)}`);
          } else {
            log.push("Source code written");
          }
    
          // 3. Unlock (must unlock before activation)
          await this.http.post(
            `/sap/bc/adt/oo/classes/${nameLower}?_action=UNLOCK&lockHandle=${encodeURIComponent(lockHandle)}`,
            "",
            { headers: this.statefulHeaders(), responseType: "text", validateStatus: () => true }
          );
          log.push("Unlocked");
    
          // 4. Activate
          const activateBody = `<?xml version="1.0" encoding="UTF-8"?>
    <adtcore:objectReferences xmlns:adtcore="http://www.sap.com/adt/core">
      <adtcore:objectReference adtcore:uri="/sap/bc/adt/oo/classes/${nameLower}" adtcore:name="${nameUpper}"/>
    </adtcore:objectReferences>`;
    
          const actResp = await this.http.post(
            "/sap/bc/adt/activation?method=activate&preauditRequested=true",
            activateBody,
            {
              headers: this.statefulHeaders({
                "Content-Type": "application/xml",
                Accept: "application/xml",
              }),
              responseType: "text",
              validateStatus: () => true,
            }
          );
    
          const actData = actResp.data as string;
          if (actData.includes('activationExecuted="true"')) {
            log.push("Activated successfully");
          } else {
            const msgMatch = actData.match(/<msg:shortText>([\s\S]*?)<\/msg:shortText>/);
            log.push(`Activation: ${msgMatch?.[1] ?? `HTTP ${actResp.status}`}`);
          }
        } finally {
          await this.endStatefulSession();
        }
    
        return log.join("\n");
      }
  • The call handler in mcp-server.ts dispatches 'change_abap_class' to `client.changeAbapClass()`, parsing args using ChangeClassSchema.
    case "change_abap_class": {
      const { name: className, source } = ChangeClassSchema.parse(args);
      const log = await client.changeAbapClass(className, source);
      return { content: [{ type: "text", text: log }] };
    }
  • The ChangeClassSchema defines input validation for the tool (name and source fields).
    const ChangeClassSchema = z.object({
      name: z.string(),
      source: z.string(),
    });
  • The tool 'change_abap_class' is registered in the ListToolsRequestSchema handler with its name, description, and inputSchema.
    {
      name: "change_abap_class",
      description: "Modify an existing ABAP class in the SAP system. Locks the object, writes the new source, activates, and unlocks. Use get_class first to read the current source.",
      inputSchema: {
        type: "object" as const,
        properties: {
          name: { type: "string", description: "Class name (e.g. ZCL_MY_CLASS)" },
          source: { type: "string", description: "Complete new ABAP class source code including CLASS definition and IMPLEMENTATION." },
          ...SYSTEM_ID_PROP,
        },
        required: ["name", "source"],
      },
    },
Behavior5/5

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

No annotations provided, but description fully discloses behavioral traits: locks the object, writes source, activates, and unlocks. This informs the agent about side effects and execution steps.

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 concise sentences, no wasted words. Purpose is front-loaded, and the usage guideline is immediately actionable.

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?

With no output schema or annotations, the description adequately covers purpose, prerequisites, and behavior. Missing details on return value or error handling, but acceptable for the tool's complexity.

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%, but description adds value by clarifying that the source parameter must include complete CLASS definition and IMPLEMENTATION. Provides additional context beyond schema.

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?

Description clearly states 'Modify an existing ABAP class' with specific verb and resource, distinguishing it from sibling tools like create_abap_class and change_abap_program.

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?

Provides explicit prerequisite: 'Use get_class first to read the current source.' Does not explicitly state when not to use or alternatives, but gives clear context for correct usage.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ethanhan2014/sap-adt-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server