Skip to main content
Glama

site_match

Match a site name to identify corresponding sites within your account using input criteria.

Instructions

Identify which site in the account matches the provided input criteria.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
recordNameYesThe name of the site to match

Implementation Reference

  • The handler function that implements the logic for the 'site_match' tool. It retrieves the recordName from the request arguments and calls the api.getMatchSite method to find the matching site, then returns the result as JSON text content.
    export const site_match = async (request: CallToolRequest) => {
      const res = await api.getMatchSite({
        recordName: request.params.arguments?.recordName ?? '',
      } as GetMatchSiteRequest);
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(res),
          },
        ],
        success: true,
      };
    };
  • The schema definition for the 'site_match' tool, specifying the input parameters (recordName) and description.
    export const SITE_MATCH_TOOL: Tool = {
      name: 'site_match',
      description:
        'Identify which site in the account matches the provided input criteria.',
      inputSchema: {
        type: 'object',
        properties: {
          recordName: {
            type: 'string',
            description: 'The name of the site to match',
          },
        },
        required: ['recordName'],
      },
    };
  • Registration of the SITE_MATCH_TOOL schema in the ESA_OPENAPI_ER_LIST array used for listing available tools.
    export const ESA_OPENAPI_ER_LIST = [
      HTML_DEPLOY_TOOL,
      ROUTINE_CREATE_TOOL,
      ROUTINE_DELETE_TOOL,
      ROUTINE_LIST_TOOL,
      ROUTINE_GET_TOOL,
      ROUTINE_CODE_COMMIT_TOOL,
      ROUTINE_CODE_DEPLOY_TOOL,
      ROUTINE_ROUTE_LIST_TOOL,
      DEPLOYMENT_DELETE_TOOL,
      SITE_ACTIVE_LIST_TOOL,
      SITE_ROUTE_LIST_TOOL,
      ROUTE_CREATE_TOOL,
      ROUTE_DELETE_TOOL,
      ROUTE_UPDATE_TOOL,
      ROUTE_GET_TOOL,
      SITE_MATCH_TOOL,
      ER_RECORD_CREATE_TOOL,
      ER_RECORD_DELETE_TOOL,
      ER_RECORD_LIST_TOOL,
    ];
  • The esaHandlers object registers the site_match handler function along with other tool handlers.
    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?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool 'identifies' a site, implying a read-only lookup, but doesn't specify what happens if no match is found (e.g., returns null, error), the matching logic (exact vs. partial), or any performance considerations like rate limits. This leaves significant gaps in understanding the tool's 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, efficient sentence that front-loads the core purpose without unnecessary details. It avoids redundancy and wastes no words, making it easy for an agent to parse quickly and understand the tool's intent.

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?

For a tool with no annotations, no output schema, and a single parameter, the description is incomplete. It doesn't explain the return value (e.g., site details or null), error conditions, or how it differs from similar siblings like 'list_sites.' This leaves the agent with insufficient context to use the tool effectively in complex scenarios.

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 'recordName' documented as 'The name of the site to match.' The description adds no additional parameter semantics beyond this, as it doesn't explain format constraints or matching rules. Given the high schema coverage, a baseline score of 3 is appropriate, as the description doesn't compensate but also doesn't 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 as 'identify which site in the account matches the provided input criteria,' which is a specific verb+resource combination. It distinguishes itself from siblings like 'list_sites' (which presumably lists all sites) by focusing on matching against criteria. However, it doesn't explicitly contrast with other potential matching tools, keeping it from 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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, such as whether the site must exist in the account, or compare it to siblings like 'get_record' or 'list_sites' for different lookup needs. This lack of contextual direction leaves the agent without clear usage rules.

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