Skip to main content
Glama

get_system_info

Retrieve SAP Commerce Cloud (Hybris) system details and health status for monitoring and troubleshooting.

Instructions

Get Hybris system information and health status

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The implementation of the getSystemInfo method, which executes a Groovy script to collect system information and parses the JSON response.
      async getSystemInfo(): Promise<Record<string, unknown>> {
        // Use Groovy script to get system info
        const script = `
    import de.hybris.platform.core.Registry
    import de.hybris.platform.util.Config
    
    def tenant = Registry.getCurrentTenant()
    def runtime = Runtime.getRuntime()
    
    def info = [
        hybrisVersion: Config.getString("build.version", "unknown"),
        buildNumber: Config.getString("build.number", "unknown"),
        tenantId: tenant.getTenantID(),
        clusterId: Config.getInt("cluster.id", 0),
        clusterIsland: Config.getInt("cluster.island.id", 0),
        javaVersion: System.getProperty("java.version"),
        javaVendor: System.getProperty("java.vendor"),
        osName: System.getProperty("os.name"),
        osArch: System.getProperty("os.arch"),
        maxMemoryMB: (runtime.maxMemory() / 1024 / 1024) as int,
        totalMemoryMB: (runtime.totalMemory() / 1024 / 1024) as int,
        freeMemoryMB: (runtime.freeMemory() / 1024 / 1024) as int,
        availableProcessors: runtime.availableProcessors()
    ]
    
    return groovy.json.JsonOutput.toJson(info)
    `;
        const result = await this.executeGroovyScript(script);
        try {
          // Parse the JSON result - executionResult contains the returned value
          const jsonStr = String(result.result || '');
          if (jsonStr && jsonStr.startsWith('{')) {
            return JSON.parse(jsonStr);
          }
          // If result is not JSON, return what we have
          return {
  • src/index.ts:293-303 (registration)
    The definition and registration of the 'get_system_info' tool within the MCP tool list.
    {
      name: 'get_system_info',
      description: 'Get Hybris system information and health status',
      inputSchema: {
        type: 'object',
        properties: {},
      },
    },
    {
      name: 'trigger_catalog_sync',
      description: 'Trigger a catalog synchronization between versions',
  • The case statement handling the 'get_system_info' tool call by invoking the hybrisClient.getSystemInfo() method.
    case 'get_system_info':
      result = await hybrisClient.getSystemInfo();
      break;

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.2/5.0
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool retrieves information and health status, implying a read-only operation, but doesn't specify details like response format, error conditions, or whether it requires authentication. This is a significant gap for a tool with zero annotation coverage.

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?

The description is a single, efficient sentence that directly states the tool's function without any wasted words. It's front-loaded with the core purpose, making it easy to parse and understand quickly.

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?

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is adequate as a basic overview. However, it lacks details on what specific information or health metrics are returned, which would be helpful for an agent to understand the output fully, especially without an output schema.

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?

The tool has 0 parameters, and schema description coverage is 100%, so there's no need for parameter details in the description. The baseline for this scenario is 4, as the description appropriately focuses on the tool's purpose without redundant parameter information.

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 clearly states the action ('Get') and the resource ('Hybris system information and health status'), making the tool's purpose immediately understandable. It doesn't explicitly differentiate from siblings like 'health_check', but it's specific enough to convey its function without being tautological.

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?

The description provides no guidance on when to use this tool versus alternatives like 'health_check' or other system-related tools. It lacks any context about prerequisites, timing, or exclusions, leaving the agent to infer usage based on the name alone.

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