Skip to main content
Glama

create_site_txt_record

Add a TXT DNS record to a website in the ESA MCP Server by specifying the site ID, record name, and text value to configure domain verification or email security.

Instructions

Creates a DNS record for a specific website. Only TXT records are supported.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteIdYesThe website ID, which can be obtained by calling the [ListSites] operation.
recordNameYesThe record name.
ttlNoThe TTL of the record. Unit: seconds. If the value is 1, the TTL of the record is determined by the system. Default: 1.
dataYesThe DNS record information. The format of this field varies based on the record type. For more information, see https://www.alibabacloud.com/help/doc-detail/2708761.html
commentNoThe comment of the record. The maximum length is 100 characters.

Implementation Reference

  • The main handler function for the 'create_site_txt_record' tool. It extracts the request arguments, sets the record type to 'TXT', defaults TTL to 1 if not provided, calls the API to create the record, and returns the response.
    export const create_site_txt_record = async (request: CallToolRequest) => {
      const req = request.params.arguments as CreateRecordRequest;
    
      req.type = 'TXT';
      req.ttl = req.ttl || 1;
    
      const res = await api.createRecord(req);
    
      return {
        content: [{ type: 'text', text: JSON.stringify(res) }],
        success: true,
      };
    };
  • The input schema defining the parameters for the 'create_site_txt_record' tool, including siteId, recordName, ttl, data.value (TXT content), and comment.
    inputSchema: {
      type: 'object',
      properties: {
        siteId: {
          type: 'number',
          description:
            'The website ID, which can be obtained by calling the [ListSites] operation.',
        },
        recordName: {
          type: 'string',
          description: 'The record name.',
          examples: ['www.example.com'],
        },
        ttl: {
          type: 'number',
          description:
            'The TTL of the record. Unit: seconds. If the value is 1, the TTL of the record is determined by the system. Default: 1.',
          examples: [1],
        },
        data: {
          type: 'object',
          description:
            'The DNS record information. The format of this field varies based on the record type. For more information, see https://www.alibabacloud.com/help/doc-detail/2708761.html',
          properties: {
            value: {
              type: 'string',
              description: 'A valid text string. Required.',
              example: ['xxxxxxxxxxxxxxxxxx'],
            },
          },
        },
        comment: {
          type: 'string',
          description:
            'The comment of the record. The maximum length is 100 characters.',
        },
      },
      required: ['siteId', 'recordName', 'type', 'data'],
      annotations: {
        readOnlyHint: false,
        destructiveHint: false,
        idempotentHint: false,
        openWorldHint: false,
      },
  • The Tool object definition for 'create_site_txt_record', which includes the name, description, and inputSchema. This is exported and used for registration.
    export const CREATE_SITE_TXT_RECORD_TOOL: Tool = {
      name: 'create_site_txt_record',
      description:
        'Creates a DNS record for a specific website. Only TXT records are supported.',
      inputSchema: {
        type: 'object',
        properties: {
          siteId: {
            type: 'number',
            description:
              'The website ID, which can be obtained by calling the [ListSites] operation.',
          },
          recordName: {
            type: 'string',
            description: 'The record name.',
            examples: ['www.example.com'],
          },
          ttl: {
            type: 'number',
            description:
              'The TTL of the record. Unit: seconds. If the value is 1, the TTL of the record is determined by the system. Default: 1.',
            examples: [1],
          },
          data: {
            type: 'object',
            description:
              'The DNS record information. The format of this field varies based on the record type. For more information, see https://www.alibabacloud.com/help/doc-detail/2708761.html',
            properties: {
              value: {
                type: 'string',
                description: 'A valid text string. Required.',
                example: ['xxxxxxxxxxxxxxxxxx'],
              },
            },
          },
          comment: {
            type: 'string',
            description:
              'The comment of the record. The maximum length is 100 characters.',
          },
        },
        required: ['siteId', 'recordName', 'type', 'data'],
        annotations: {
          readOnlyHint: false,
          destructiveHint: false,
          idempotentHint: false,
          openWorldHint: false,
        },
      },
    };
  • Registration of the CREATE_SITE_TXT_RECORD_TOOL in the ESA_OPENAPI_SITE_LIST array, which collects tools for the ESA OpenAPI.
    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,
    ];
  • Registration of the create_site_txt_record handler function in the esaHandlers object, mapping tool names to their implementations.
    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,
    };
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 states 'Creates a DNS record,' which implies a write operation, but doesn't disclose behavioral traits such as whether it requires specific permissions, if it's idempotent, what happens on conflicts, or error conditions. The description adds minimal context beyond the basic action.

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 two sentences with zero waste: it states the purpose and constraint efficiently. It's appropriately sized and front-loaded, with every sentence earning its place by clarifying the tool's scope.

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 complexity (5 parameters, nested objects, no output schema) and lack of annotations, the description is minimal. It covers the basic purpose and record type constraint but doesn't address behavioral aspects, error handling, or output expectations. For a creation tool with no annotations, this leaves significant 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?

Schema description coverage is 100%, so the schema already documents all parameters thoroughly. The description adds no additional meaning about parameters beyond what the schema provides, such as explaining the 'siteId' dependency or 'data' format specifics. Baseline 3 is appropriate when schema coverage is high.

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 ('Creates a DNS record') and resource ('for a specific website'), and specifies that 'Only TXT records are supported.' However, it doesn't explicitly differentiate from sibling tools like create_site_a_or_aaaa_record or create_site_cname_record, which handle different DNS record types.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage by specifying 'Only TXT records are supported,' which suggests this tool should be used for TXT records rather than other DNS record types. However, it doesn't provide explicit guidance on when to use this versus alternatives like create_site_cname_record, nor does it mention prerequisites or exclusions.

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