Skip to main content
Glama

update_site_pause

Pause or resume ESA proxy protection for a website to temporarily route traffic directly to the origin server.

Instructions

Modifies the ESA proxy configuration of a website.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteIdYesThe website ID, which can be obtained by calling the [ListSites] operation.
pausedYesSpecifies whether to temporarily pause ESA on the website. If you set this parameter to true, all requests to the domains in your DNS records go directly to your origin server. Valid values: true, false

Implementation Reference

  • The main handler function for the 'update_site_pause' tool. It takes a CallToolRequest, extracts arguments as UpdateSitePauseRequest, calls api.updateSitePause, and returns a JSON stringified response.
    export const update_site_pause = async (request: CallToolRequest) => {
      const res = await api.updateSitePause(
        request.params.arguments as UpdateSitePauseRequest,
      );
    
      return {
        content: [{ type: 'text', text: JSON.stringify(res) }],
        success: true,
      };
    };
  • The Tool object definition for 'update_site_pause', including name, description, and detailed inputSchema with properties siteId (number) and paused (boolean).
    export const UPDATE_SITE_PAUSE_TOOL: Tool = {
      name: 'update_site_pause',
      description: 'Modifies 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****'],
          },
          paused: {
            type: 'boolean',
            description:
              'Specifies whether to temporarily pause ESA on the website. If you set this parameter to true, all requests to the domains in your DNS records go directly to your origin server. Valid values: true, false',
            examples: ['true'],
          },
        },
        required: ['siteId', 'paused'],
        annotations: {
          readOnlyHint: false,
          destructiveHint: true,
          idempotentHint: true,
          openWorldHint: false,
        },
      },
    };
  • The esaHandlers object registers the update_site_pause handler function (line 186) along with other tools, likely used for MCP tool registration.
    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,
    };
  • ESA_OPENAPI_SITE_LIST array includes UPDATE_SITE_PAUSE_TOOL (line 128), collecting Tool definitions for site-related OpenAPI tools.
    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,
    ];
  • The api.updateSitePause helper method that wraps the Alibaba Cloud ESA client call to update site pause status.
    updateSitePause(params: UpdateSitePauseRequest) {
      params.pause = params.pause || false;
      const request = new UpdateSitePauseRequest(params);
      return this.callApi(
        this.client.updateSitePause.bind(this.client) as ApiMethod<
          UpdateSitePauseRequest,
          UpdateSitePauseResponse
        >,
        request,
      );
    }
Behavior3/5

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

No annotations are provided, so the description carries the full burden. 'Modifies' implies a mutation, but it doesn't disclose critical behavioral traits like whether it's idempotent, destructive, requires specific permissions, or has rate limits. The description adds minimal context beyond the basic action, leaving gaps in safety and operational understanding.

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 with zero waste. It's front-loaded with the core action and resource, making it easy to parse. Every word earns its place, and there's no redundancy or unnecessary elaboration.

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 the complexity of a mutation tool with no annotations and no output schema, the description is incomplete. It lacks behavioral details (e.g., idempotency, destructiveness), usage context, and information on return values or errors. For a tool that modifies site configurations, this leaves significant gaps for an AI agent to operate safely and effectively.

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 clear documentation for both parameters (siteId and paused), including examples and validation. The description doesn't add any meaning beyond what the schema provides, such as explaining the impact of pausing ESA or how to obtain the siteId. Baseline 3 is appropriate since the schema does the heavy lifting.

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 ('Modifies') and the resource ('ESA proxy configuration of a website'), which is specific and distinguishes it from siblings like 'get_site_pause' (read) or 'create_site' (create). However, it doesn't explicitly differentiate from other update tools like 'update_record' or 'update_ipv6' beyond the resource focus.

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 prerequisites (e.g., needing a site ID from 'list_sites'), exclusions, or comparisons to related tools like 'get_site_pause' for checking status or other site modification tools. Usage is implied only by the action and resource.

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