site_route_list
Retrieve and filter all routes linked to a specific site using site ID, route name, pagination, and page size for streamlined route management.
Instructions
List all routes associated with a specific site.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pageNumber | No | The page number of the routes | |
| pageSize | No | The page size of the routes | |
| routeName | No | The name of the route, use to filter list results | |
| siteId | Yes | The ID of the site |
Implementation Reference
- src/tools/er/route.ts:308-316 (handler)The handler function that implements the core logic of the 'site_route_list' tool by calling the API to list site routes and serializing the response.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, }; };
- src/tools/er/route.ts:206-232 (schema)The tool schema defining the name, description, and input parameters for 'site_route_list'.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'], }, };
- src/tools/list-esa-function.ts:103-123 (registration)Registration of the SITE_ROUTE_LIST_TOOL in the list of ESA OpenAPI ER 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:164-208 (registration)The esaHandlers object registers the site_route_list handler function for invocation.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, };