Skip to main content
Glama

get_ipv6

Retrieve IPv6 configuration details for a website to verify network settings and ensure proper connectivity.

Instructions

Queries the IPv6 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 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,
      };
    };
  • 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,
        },
      },
    };
  • 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,
    };
  • 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];
  • 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,
      );
    }
Behavior2/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. It mentions 'Queries' which implies a read operation, but doesn't disclose behavioral traits like whether it requires authentication, rate limits, error conditions, or what the output format looks like. This is inadequate for a tool with no 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, clear sentence with no wasted words. It's appropriately sized and front-loaded, making it easy to understand at a glance.

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 and no output schema, the description is incomplete. It doesn't explain what the query returns (e.g., IPv6 addresses, configuration details), error handling, or dependencies. For a query tool with no structured support, 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?

The description doesn't add any parameter semantics beyond what's in the input schema, which has 100% coverage. The schema already documents 'siteId' with its description and example. Baseline 3 is appropriate as 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 ('Queries') and resource ('IPv6 configuration of a website'), making the purpose evident. However, it doesn't explicitly differentiate from sibling tools like 'update_ipv6' or 'get_record', which would be needed for a perfect 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?

No guidance is provided on when to use this tool versus alternatives like 'get_record' or 'list_sites', nor does it mention prerequisites such as needing a siteId from 'list_sites'. The description only states what it does, not when to use it.

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