ESA MCP Server

Instructions

Implementation Reference

• src/tools/site/ipv6.ts:70-77 (handler)

  The handler function that executes the 'get_ipv6' tool logic. It calls the API service's getIPv6 method with the provided arguments and returns the response as JSON in the tool content.

  export const get_ipv6 = async (request: CallToolRequest) => {
    const res = await api.getIPv6(request.params.arguments as GetIPv6Request);
  
    return {
      content: [{ type: 'text', text: JSON.stringify(res) }],
      success: true,
    };
  };

• src/tools/site/ipv6.ts:37-57 (schema)

  The tool schema definition for 'get_ipv6', including input schema specifying the required 'siteId' parameter and annotations.

  export const GET_IPV6_TOOL: Tool = {
    name: 'get_ipv6',
    description: 'Queries the IPv6 configuration of a website.',
    inputSchema: {
      type: 'object',
      properties: {
        siteId: {
          type: 'number',
          description:
            'The website ID, which can be obtained by calling the ListSites operation.',
          example: [12228828888],
        },
      },
      required: ['siteId'],
      annotations: {
        readOnlyHint: true,
        destructiveHint: false,
        idempotentHint: false,
      },
    },
  };

• src/tools/list-esa-function.ts:164-208 (registration)

  Registration of the 'get_ipv6' handler in the esaHandlers object, which maps tool names to their handler functions for the MCP server.

  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,
  };

• src/tools/list-esa-function.ts:141-141 (registration)

  Inclusion of GET_IPV6_TOOL in the IPV6_LIST, which is further included in the main ESA_OPENAPI_LIST for tool registration.

  export const IPV6_LIST = [UPDATE_IPV6_TOOL, GET_IPV6_TOOL];

• src/utils/service.ts:466-475 (helper)

  Helper service method that wraps the Alibaba Cloud ESA API call for retrieving IPv6 configuration.

  getIPv6(params: GetIPv6Request) {
    const request = new GetIPv6Request(params);
    return this.callApi(
      this.client.getIPv6.bind(this.client) as ApiMethod<
        GetIPv6Request,
        GetIPv6Response
      >,
      request,
    );
  }