Skip to main content
Glama

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
NameRequiredDescriptionDefault
environmentIdYesID of the environment containing the service
serviceIdYesID of the service to list TCP proxies for

Implementation Reference

  • 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);
    }
  • 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")
    },
  • 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);
      }
    ),
  • Registers all tools, including 'tcp_proxy_list' from tcpProxyTools, with the MCP server.
    allTools.forEach((tool) => {
      server.tool(
        ...tool
      );
    });
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It implies a read-only operation (listing proxies) and hints at configuration management, but does not disclose behavioral traits like pagination, rate limits, authentication needs, or error handling. The description adds some context (e.g., for auditing) but lacks detailed behavioral transparency.

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 well-structured and front-loaded: the first sentence states the core purpose, followed by bullet-point sections (Best for, Prerequisites, Next steps, Related) that efficiently provide additional context without redundancy. Every sentence earns its place, making it concise and easy to scan.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (2 required parameters, no output schema, no annotations), the description is mostly complete. It covers purpose, usage guidelines, and related tools, but lacks details on behavioral aspects (e.g., output format, error cases) and does not fully compensate for the absence of annotations. It is adequate but has minor gaps.

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 input schema already documents both parameters (environmentId and serviceId) with descriptions. The description does not add any parameter-specific semantics beyond what the schema provides, such as format examples or constraints. Baseline 3 is appropriate when schema coverage is high.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'List all TCP proxies for a service in a specific environment.' It specifies the verb ('List'), resource ('TCP proxies'), and scope ('for a service in a specific environment'), distinguishing it from siblings like tcp_proxy_create (which creates proxies) and domain_list (which lists domains).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage guidance with sections: 'Best for' lists use cases (viewing configurations, managing access, auditing endpoints), 'Prerequisites' specifies service_list as a required step, 'Next steps' suggests tcp_proxy_create, and 'Related' mentions domain_list and service_info as alternatives. This clearly indicates when to use this tool versus others.

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/epitaphe360/railway-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server