Skip to main content
Glama

get_site_pause

Check if a website's ESA proxy configuration is paused by providing its site ID. Use this tool to verify proxy status and manage website security settings.

Instructions

Queries the ESA proxy configuration of a website.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteIdYesThe website ID, which can be obtained by calling the [ListSites] operation.

Implementation Reference

  • The handler function that implements the core logic of the 'get_site_pause' tool by invoking the API service with the provided arguments and returning a formatted response.
    export const get_site_pause = async (request: CallToolRequest) => {
      const res = await api.getSitePause(
        request.params.arguments as GetSitePauseRequest,
      );
    
      return {
        content: [{ type: 'text', text: JSON.stringify(res) }],
        success: true,
      };
    };
  • Tool registration exporting the Tool object with name 'get_site_pause', description, and input schema definition.
    export const GET_SITE_PAUSE_TOOL: Tool = {
      name: 'get_site_pause',
      description: 'Queries the ESA proxy configuration of a website.',
      inputSchema: {
        type: 'object',
        properties: {
          siteId: {
            type: 'number',
            description:
              'The website ID, which can be obtained by calling the [ListSites] operation.',
            examples: ['123456****'],
          },
        },
        required: ['siteId'],
        annotations: {
          readOnlyHint: true,
          destructiveHint: false,
          idempotentHint: true,
          openWorldHint: false,
        },
      },
    };
  • Central registration of all tool handlers, including 'get_site_pause'.
    export const esaHandlers: ToolHandlers = {
      site_active_list,
      site_match,
      site_route_list,
      site_record_list,
      routine_create,
      routine_code_commit,
      routine_delete,
      routine_list,
      routine_get,
      routine_code_deploy,
      routine_route_list,
      deployment_delete,
      route_create,
      route_delete,
      route_update,
      route_get,
      er_record_create,
      er_record_delete,
      er_record_list,
      html_deploy,
      create_site,
      update_site_pause,
      get_site_pause,
      create_site_mx_record,
      create_site_ns_record,
      create_site_txt_record,
      create_site_cname_record,
      create_site_a_or_aaaa_record,
      update_record,
      list_records,
      get_record,
      delete_record,
      update_ipv6,
      get_ipv6,
      update_managed_transform,
      get_managed_transform,
      set_certificate,
      apply_certificate,
      get_certificate,
      delete_certificate,
      list_certificates,
      get_certificate_quota,
      list_sites,
    };
  • Registration of site-related tools list including GET_SITE_PAUSE_TOOL.
    export const ESA_OPENAPI_SITE_LIST = [
      LIST_SITES_TOOL,
      CREATE_SITE_TOOL,
      UPDATE_SITE_PAUSE_TOOL,
      GET_SITE_PAUSE_TOOL,
      UPDATE_RECORD_TOOL,
      CREATE_SITE_MX_RECORD_TOOL,
      CREATE_SITE_NS_RECORD_TOOL,
      CREATE_SITE_TXT_RECORD_TOOL,
      CREATE_SITE_CNAME_RECORD_TOOL,
      CREATE_SITE_A_OR_AAAA_RECORD_TOOL,
      DELETE_RECORD_TOOL,
      LIST_RECORDS_TOOL,
      GET_RECORD_TOOL,
    ];
  • Helper method in the API service client that performs the actual Alibaba Cloud ESA API call for getting site pause status.
    getSitePause(params: GetSitePauseRequest) {
      const request = new GetSitePauseRequest(params);
      return this.callApi(
        this.client.getSitePause.bind(this.client) as ApiMethod<
          GetSitePauseRequest,
          GetSitePauseResponse
        >,
        request,
      );
    }
Behavior3/5

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

The description adds minimal behavioral context beyond the input schema annotations. It implies a read-only query operation, which aligns with the annotations (readOnlyHint: true, destructiveHint: false, idempotentHint: true), but doesn't disclose additional traits like rate limits, authentication needs, or what 'ESA proxy configuration' entails. With annotations covering safety and idempotency, the description meets a baseline by not contradicting them but offers little extra insight.

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 front-loads the core action ('Queries') and resource ('ESA proxy configuration of a website'), with zero wasted words. It's appropriately sized for a simple query tool, 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 low complexity (1 parameter, 100% schema coverage, annotations provided), the description is minimally adequate but lacks depth. It doesn't explain the return values (no output schema exists) or how the ESA proxy configuration relates to other site operations, leaving gaps in full contextual understanding despite the structured data covering basics.

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 description doesn't add any parameter-specific information beyond what's in the input schema, which has 100% coverage and fully documents the single 'siteId' parameter. Since the schema does the heavy lifting, the baseline score of 3 is appropriate, as the description neither compensates for gaps nor enhances understanding of the parameter's role in the query.

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 tool's purpose with a specific verb ('Queries') and resource ('ESA proxy configuration of a website'), making it immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'get_certificate' or 'get_record', which also query configurations but for different resources, leaving room for slight ambiguity in sibling context.

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. It doesn't mention related tools like 'list_sites' (which might be needed to obtain siteId) or 'update_site_pause' (which modifies the same configuration), nor does it specify any prerequisites or contextual triggers for 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/aliyun/mcp-server-esa'

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