Skip to main content
Glama

site_route_list

Retrieve all routes for a specific site to manage network paths and filter results by name or pagination.

Instructions

List all routes associated with a specific site.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteIdYesThe ID of the site
routeNameNoThe name of the route, use to filter list results
pageNumberNoThe page number of the routes
pageSizeNoThe page size of the routes

Implementation Reference

  • The handler function that implements the core logic of the site_route_list tool by calling api.listSiteRoutes with the provided arguments and returning the result as JSON.
    export const site_route_list = async (request: CallToolRequest) => {
      const res = await api.listSiteRoutes(
        request.params.arguments as ListSiteRoutesRequest,
      );
      return {
        content: [{ type: 'text', text: JSON.stringify(res) }],
        success: true,
      };
    };
  • The tool schema definition for site_route_list, specifying the name, description, and input validation schema.
    export const SITE_ROUTE_LIST_TOOL: Tool = {
      name: 'site_route_list',
      description: 'List all routes associated with a specific site.',
      inputSchema: {
        type: 'object',
        properties: {
          siteId: {
            type: 'number',
            description: 'The ID of the site',
          },
          routeName: {
            type: 'string',
            description: 'The name of the route, use to filter list results',
          },
    
          pageNumber: {
            type: 'number',
            description: 'The page number of the routes',
          },
          pageSize: {
            type: 'number',
            description: 'The page size of the routes',
          },
        },
        required: ['siteId'],
      },
    };
  • Registration of SITE_ROUTE_LIST_TOOL in the ESA_OPENAPI_ER_LIST array, which collects available ER-related 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,
    ];
  • Registration of the site_route_list 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?

With no annotations provided, the description carries the full burden of behavioral disclosure. While 'List' implies a read-only operation, the description doesn't address important behavioral aspects like pagination behavior (implied by pageNumber/pageSize parameters but not explained), rate limits, authentication requirements, error conditions, or what format the returned routes will have. This leaves significant gaps for a tool with pagination parameters.

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 gets straight to the point with zero wasted words. It's appropriately sized for a straightforward listing operation and front-loads the core functionality.

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 pagination parameters (pageNumber, pageSize) and no output schema, the description is insufficient. It doesn't explain the pagination behavior, return format, or what constitutes a 'route' in this context. With no annotations and no output schema, the description should provide more context about the operation's behavior and results.

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 schema has 100% description coverage, so all parameters are documented in the schema itself. The description doesn't add any meaningful parameter semantics beyond what's already in the schema - it mentions filtering by site but doesn't explain the relationship between siteId and routeName filtering or how pagination works. This meets the baseline for high schema coverage.

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 ('List all routes') and the target resource ('associated with a specific site'), providing a specific verb+resource combination. However, it doesn't distinguish this tool from sibling tools like 'routine_route_list' or 'er_record_list', which appear to perform similar listing operations for different resources.

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. There's no mention of prerequisites, when-not-to-use scenarios, or comparisons to sibling tools like 'route_get' (for single routes) or 'routine_route_list' (which might list routes for routines rather than sites).

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