Skip to main content
Glama

get_record

Retrieve DNS record configuration including values, priority, and authentication settings for CNAME records by providing the record ID.

Instructions

Queries the configuration of a single DNS record, such as the record value, priority, and origin authentication setting (exclusive to CNAME records).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
recordIdYesThe record ID, which can be obtained by calling ListRecords.

Implementation Reference

  • The handler function that executes the 'get_record' tool logic. It casts arguments to GetRecordRequest, calls the API service, and formats the response as MCP tool output.
    export const get_record = async (request: CallToolRequest) => {
      const req = request.params.arguments as GetRecordRequest;
    
      const res = await api.getRecord(req);
    
      return {
        content: [{ type: 'text', text: JSON.stringify(res) }],
        success: true,
      };
    };
  • The tool registration object defining the 'get_record' tool, including its name, description, input schema (requiring recordId), and annotations.
    export const GET_RECORD_TOOL: Tool = {
      name: 'get_record',
      description:
        'Queries the configuration of a single DNS record, such as the record value, priority, and origin authentication setting (exclusive to CNAME records).',
      inputSchema: {
        type: 'object',
        properties: {
          recordId: {
            type: 'number',
            description: 'The record ID, which can be obtained by calling ListRecords.',
            examples: [1234567890123],
          },
        },
        required: ['recordId'],
        annotations: {
          readOnlyHint: true,
          destructiveHint: false,
          idempotentHint: false,
        },
      },
    };
  • Global registration of the 'get_record' tool (as GET_RECORD_TOOL) in the ESA_OPENAPI_SITE_LIST array, which aggregates site-related 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,
    ];
  • Mapping of tool handlers in esaHandlers, including 'get_record' handler for execution dispatch.
    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,
    };
  • Helper method in the API service client that wraps the Alibaba Cloud ESA 'getRecord' API call, handling request creation and runtime options.
    getRecord(params: GetRecordRequest) {
      const request = new GetRecordRequest(params);
      return this.callApi(
        this.client.getRecord.bind(this.client) as ApiMethod<
          GetRecordRequest,
          GetRecordResponse
        >,
        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 of behavioral disclosure. It describes a read operation ('queries'), which implies non-destructive behavior, but does not address potential side effects, error conditions, authentication needs, or rate limits. For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior.

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, well-structured sentence that efficiently conveys the tool's purpose and key details without unnecessary words. It is front-loaded with the main action and includes specific examples, 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 (one parameter, no output schema) and high schema coverage, the description is somewhat complete but lacks depth. It covers the basic purpose but misses usage guidelines and behavioral details, which are important for a tool without annotations. This results in a minimal viable description with clear gaps.

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 input schema has 100% description coverage, with the 'recordId' parameter fully documented in the schema. The description adds no additional parameter semantics beyond what the schema provides, such as format constraints or examples. According to the rules, with high schema coverage, the baseline score is 3, as the description does not compensate but also does not detract.

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 ('configuration of a single DNS record'), and it lists example attributes like record value, priority, and origin authentication setting. However, it does not explicitly distinguish this tool from sibling tools like 'list_records' or 'get_certificate', which slightly reduces clarity in 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, such as 'list_records' for multiple records or other 'get_' tools for different resources. It mentions that the record ID can be obtained from 'ListRecords', but this is a parameter detail rather than usage context, leaving the agent without explicit when-to-use instructions.

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