boscli_route_list
List all BOS routes. Filter by module to discover specific API endpoints for ERP operations.
Instructions
List all BOS routes, optionally filtered by module
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "boscli_route_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| module | No | ||
| limit | No |
Implementation Reference
- src/tools/route.ts:12-12 (handler)Handler function for boscli_route_list: calls client.get('/boscli/routes', args) to fetch routes from the API, optionally filtered by module and limit.
handler: async (args, client) => client.get('/boscli/routes', args), - src/tools/route.ts:8-11 (schema)Schema definition for boscli_route_list: accepts optional 'module' (string) and 'limit' (number) parameters.
schema: { module: { type: 'string', optional: true }, limit: { type: 'number', optional: true }, }, - src/tools/route.ts:4-20 (registration)Tool registration as part of the routeTools array exported from src/tools/route.ts. The tool named 'boscli_route_list' is defined alongside 'boscli_route_by_module'.
export const routeTools: McpTool[] = [ { name: 'boscli_route_list', description: 'List all BOS routes, optionally filtered by module', schema: { module: { type: 'string', optional: true }, limit: { type: 'number', optional: true }, }, handler: async (args, client) => client.get('/boscli/routes', args), }, { name: 'boscli_route_by_module', description: 'Get all routes for a specific BOS module', schema: { module: { type: 'string', description: 'Module name to filter routes' } }, handler: async (args, client) => client.get(`/boscli/routes/${args.module}`), }, ];