tcp_proxy_list
View and manage TCP proxy configurations for Railway.app services to control external access and audit service endpoints.
Instructions
[API] List all TCP proxies for a service in a specific environment
⚡️ Best for: ✓ Viewing TCP proxy configurations ✓ Managing external access ✓ Auditing service endpoints
→ Prerequisites: service_list
→ Next steps: tcp_proxy_create
→ Related: domain_list, service_info
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| environmentId | Yes | ID of the environment containing the service | |
| serviceId | Yes | ID of the service to list TCP proxies for |
Implementation Reference
- src/tools/tcpProxy.tool.ts:26-28 (handler)The handler function for the 'tcp_proxy_list' tool, which calls tcpProxyService.listTcpProxies(environmentId, serviceId) to list TCP proxies for a service.async ({ environmentId, serviceId }) => { return tcpProxyService.listTcpProxies(environmentId, serviceId); }
- src/tools/tcpProxy.tool.ts:22-25 (schema)Zod schema defining the input parameters for the 'tcp_proxy_list' tool: environmentId and serviceId.{ environmentId: z.string().describe("ID of the environment containing the service"), serviceId: z.string().describe("ID of the service to list TCP proxies for") },
- src/tools/tcpProxy.tool.ts:6-29 (registration)Tool definition using createTool, including name, description, schema, and handler for 'tcp_proxy_list'.createTool( "tcp_proxy_list", formatToolDescription({ type: 'API', description: "List all TCP proxies for a service in a specific environment", bestFor: [ "Viewing TCP proxy configurations", "Managing external access", "Auditing service endpoints" ], relations: { prerequisites: ["service_list"], nextSteps: ["tcp_proxy_create"], related: ["domain_list", "service_info"] } }), { environmentId: z.string().describe("ID of the environment containing the service"), serviceId: z.string().describe("ID of the service to list TCP proxies for") }, async ({ environmentId, serviceId }) => { return tcpProxyService.listTcpProxies(environmentId, serviceId); } ),
- src/tools/index.ts:32-36 (registration)Registers all tools, including 'tcp_proxy_list' from tcpProxyTools, with the MCP server.allTools.forEach((tool) => { server.tool( ...tool ); });