Skip to main content
Glama

route_update

Modify an existing Edge Routine route configuration to update settings like enable status, rules, routines, and bypass options for site security management.

Instructions

Modify the configuration of an existing Edge Routine route.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteIdYesThe ID of the site
configIdYesThe ID of the config
routeNameYesThe name of the route, use to identify the route.
routeEnableYesThe enable of the route
ruleYesThe rule of the route
routineNameYesThe name of the routine
bypassYesThe bypass of the route
sequenceNoThe sequence of the route, if not passed, default is the current number of routes

Implementation Reference

  • The primary handler function for the 'route_update' tool. It processes the request arguments, handles 'simple' and 'custom' modes by calling api.updateRoutineRoute, and returns the result as JSON.
    export const route_update = async (request: CallToolRequest) => {
      const { mode, route } = request.params.arguments as CreateRoutineRouteRequest;
      if (mode === 'simple') {
        const res = await api.updateRoutineRoute({
          ...request.params.arguments,
          rule: transferRouteToRuleString(route),
        } as unknown as UpdateRoutineRouteRequest);
        return {
          content: [{ type: 'text', text: JSON.stringify(res) }],
          success: true,
        };
      } else {
        const res = await api.updateRoutineRoute(
          request.params.arguments as UpdateRoutineRouteRequest,
        );
        return {
          content: [{ type: 'text', text: JSON.stringify(res) }],
          success: true,
        };
      }
    };
  • The Tool object defining the 'route_update' tool, including its name, description, and detailed inputSchema with properties and required fields.
    export const ROUTE_UPDATE_TOOL: Tool = {
      name: 'route_update',
      description: 'Modify the configuration of an existing Edge Routine route.',
      inputSchema: {
        type: 'object',
        properties: {
          siteId: {
            type: 'number',
            description: 'The ID of the site',
          },
          configId: {
            type: 'number',
            description: 'The ID of the config',
          },
          routeName: {
            type: 'string',
            description: 'The name of the route, use to identify the route.',
          },
          routeEnable: {
            type: 'enum',
            enum: ['on', 'off'],
            description: 'The enable of the route',
          },
          rule: {
            type: 'string',
            description: 'The rule of the route',
          },
          routineName: {
            type: 'string',
            description: 'The name of the routine',
          },
          bypass: {
            type: 'enum',
            enum: ['on', 'off'],
            description: 'The bypass of the route ',
          },
          sequence: {
            type: 'number',
            description:
              'The sequence of the route, if not passed, default is the current number of routes',
          },
        },
        required: [
          'siteId',
          'configId',
          'routeName',
          'routeEnable',
          'rule',
          'routineName',
          'bypass',
        ],
      },
    };
  • Registration of ROUTE_UPDATE_TOOL in the ESA_OPENAPI_ER_LIST array, which collects tools for the ESA OpenAPI ER category.
    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 route_update handler function in the esaHandlers object, which maps tool names to their handler functions.
    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,
    };
  • Import statement bringing in the route_update handler and ROUTE_UPDATE_TOOL schema from the route module.
    import {
      route_create,
      ROUTE_CREATE_TOOL,
      route_delete,
      ROUTE_DELETE_TOOL,
      route_get,
      ROUTE_GET_TOOL,
      route_update,
      ROUTE_UPDATE_TOOL,
      routine_route_list,
      ROUTINE_ROUTE_LIST_TOOL,
      site_route_list,
      SITE_ROUTE_LIST_TOOL,
    } from './er/route';
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 'Modify' implying a mutation, but doesn't cover permissions, side effects, error handling, or response format. This is inadequate for a tool with 8 parameters and no output schema.

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 action and resource. It wastes no words and is appropriately sized for the tool's complexity.

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 the tool's complexity (8 parameters, 7 required, mutation operation), no annotations, and no output schema, the description is insufficient. It lacks behavioral context, usage guidelines, and details on what the modification entails or returns, making it incomplete for effective agent use.

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 fully documents all parameters. The description adds no additional meaning beyond the schema, such as explaining relationships between parameters or usage examples. Baseline 3 is appropriate when 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 ('Modify') and resource ('configuration of an existing Edge Routine route'), making the purpose evident. However, it doesn't explicitly differentiate from sibling tools like 'route_create' or 'route_get', which would require a 5.

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 like 'route_create' for new routes or 'route_delete' for removal. It lacks context about prerequisites or exclusions, leaving usage unclear.

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