route_update
Update Edge Routine route configurations to manage site-specific routing rules, enable or disable routes, and adjust sequencing within ESA MCP Server.
Instructions
Modify the configuration of an existing Edge Routine route.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bypass | Yes | The bypass of the route | |
| configId | Yes | The ID of the config | |
| routeEnable | Yes | The enable of the route | |
| routeName | Yes | The name of the route, use to identify the route. | |
| routineName | Yes | The name of the routine | |
| rule | Yes | The rule of the route | |
| sequence | No | The sequence of the route, if not passed, default is the current number of routes | |
| siteId | Yes | The ID of the site |
Implementation Reference
- src/tools/er/route.ts:266-286 (handler)The handler function that executes the route_update tool. It processes the request arguments, optionally transforms the route to a rule string if mode is 'simple', calls the updateRoutineRoute API, and returns the result.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, }; } };
- src/tools/er/route.ts:75-127 (schema)The tool schema definition for route_update, including input schema with required and optional parameters.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', ], }, };
- src/tools/list-esa-function.ts:103-123 (registration)Registration of the ROUTE_UPDATE_TOOL in the ESA_OPENAPI_ER_LIST array of 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, ];
- src/tools/list-esa-function.ts:177-180 (registration)Maps the 'route_update' handler function in the esaHandlers object for tool invocation.route_create, route_delete, route_update, route_get,