Skip to main content
Glama

aem_status

Check the status of Adobe Experience Manager instances to verify connectivity and operational state using host, port, and authentication parameters.

Instructions

Check the status of AEM instance

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostNoAEM host (default: localhost)localhost
portNoAEM port (default: 4502)
usernameNoAEM username (default: admin)admin
passwordNoAEM password (default: admin)admin

Implementation Reference

  • The main handler function for the 'aem_status' tool. It extracts configuration from input arguments, calls the AEMClient to check the instance status, and returns a formatted text response.
      async checkStatus(args: any) {
        const config = this.getConfig(args);
        const status = await this.aemClient.checkStatus(config);
        
        return {
          content: [
            {
              type: 'text',
              text: `AEM Instance Status:
    Host: ${config.host}:${config.port}
    Status: ${status.status}
    ${status.version ? `Version: ${status.version}` : ''}
    ${status.totalBundles ? `Total Bundles: ${status.totalBundles}` : ''}
    ${status.activeBundles ? `Active Bundles: ${status.activeBundles}` : ''}
    ${status.message ? `Message: ${status.message}` : ''}`,
            },
          ],
        };
      }
  • src/index.ts:48-76 (registration)
    Registers the 'aem_status' tool in the MCP server's ListTools response, providing name, description, and input schema.
    {
      name: 'aem_status',
      description: 'Check the status of AEM instance',
      inputSchema: {
        type: 'object',
        properties: {
          host: {
            type: 'string',
            description: 'AEM host (default: localhost)',
            default: 'localhost'
          },
          port: {
            type: 'number',
            description: 'AEM port (default: 4502)',
            default: 4502
          },
          username: {
            type: 'string',
            description: 'AEM username (default: admin)',
            default: 'admin'
          },
          password: {
            type: 'string',
            description: 'AEM password (default: admin)',
            default: 'admin'
          }
        }
      }
    },
  • Input schema definition for the 'aem_status' tool, specifying optional parameters for AEM connection with defaults.
    inputSchema: {
      type: 'object',
      properties: {
        host: {
          type: 'string',
          description: 'AEM host (default: localhost)',
          default: 'localhost'
        },
        port: {
          type: 'number',
          description: 'AEM port (default: 4502)',
          default: 4502
        },
        username: {
          type: 'string',
          description: 'AEM username (default: admin)',
          default: 'admin'
        },
        password: {
          type: 'string',
          description: 'AEM password (default: admin)',
          default: 'admin'
        }
      }
    }
  • Helper method to extract and provide default values for AEM configuration from tool arguments.
    private getConfig(args: any): AEMConfig {
      return {
        host: args.host || 'localhost',
        port: args.port || 4506,
        username: args.username || 'admin',
        password: args.password || 'admin',
      };
    }
  • Core helper implementing the AEM status check via HTTP request to bundles endpoint, computing bundle counts and status, asynchronously fetching version.
    async checkStatus(config: AEMConfig): Promise<any> {
      const baseUrl = this.getBaseUrl(config);
      const authHeader = this.getAuthHeader(config);
    
      try {
        const response = await this.axiosInstance.get(`${baseUrl}/system/console/bundles.json`, {
          headers: {
            'Authorization': authHeader,
          },
        });
    
        if (response.status === 200) {
          const data = response.data;
          console.log('AEM Status Data:', data);
          return {
            status: 'running',
            totalBundles: data.s?.length || 0,
            activeBundles: data.s?.filter((bundle: any) => bundle.state === 'Active').length || 0,
            version: await this.getAEMVersion(config),
          };
        } else {
          return {
            status: 'error',
            message: `HTTP ${response.status}: ${response.statusText}`,
          };
        }
      } catch (error) {
        return {
          status: 'offline',
          message: error instanceof Error ? error.message : 'Unknown error',
        };
      }
    }
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states it 'checks' status, implying a read-only operation, but doesn't specify what 'status' includes (e.g., health, uptime, metrics), whether it requires authentication (though parameters suggest it might), or any side effects like network calls. This leaves significant gaps for a tool with authentication parameters.

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, clear sentence with no wasted words. It's front-loaded with the core purpose and appropriately sized for a simple status-checking tool, making it easy for an agent to parse quickly.

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

Completeness2/5

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

Given no annotations, no output schema, and authentication parameters, the description is incomplete. It doesn't explain what 'status' entails (e.g., returns health indicators, error details), how authentication affects the check, or potential failure modes. For a tool that likely interacts with a remote system, more context is needed.

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%, with all parameters well-documented in the schema itself (host, port, username, password with defaults). The description adds no additional parameter semantics beyond implying these might be needed for checking status, so it meets the baseline for high schema coverage without adding value.

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 ('Check') and resource ('status of AEM instance'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'aem_bundle_status' which might check a more specific aspect of AEM status, so it doesn't reach the highest score.

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 'aem_bundle_status' or other AEM monitoring tools. It lacks any context about prerequisites, timing, or exclusions, leaving the agent to infer usage from the tool name alone.

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/pradeep-moolemane/aem-mcp'

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