Railway MCP Server

Instructions

Implementation Reference

• src/tools/project.tool.ts:27-49 (registration)

  The project_info tool is registered here via createTool, including its description, input schema, and handler function.

  createTool(
    "project_info",
    formatToolDescription({
      type: 'API',
      description: "Get detailed information about a specific Railway project",
      bestFor: [
        "Viewing project details and status",
        "Checking environments and services",
        "Project configuration review"
      ],
      relations: {
        prerequisites: ["project_list"],
        nextSteps: ["service_list", "variable_list"],
        related: ["project_update", "project_delete"]
      }
    }),
    {
      projectId: z.string().describe("ID of the project to get information about")
    },
    async ({ projectId }) => {
      return projectService.getProject(projectId);
    }
  ),

• src/services/project.service.ts:44-81 (handler)

  The core handler logic for retrieving and formatting project information, called by the tool handler.

    async getProject(projectId: string): Promise<CallToolResult> {
      try {
        const project = await this.client.projects.getProject(projectId);
  
        if (!project) {
          return createErrorResponse("Project not found.");
        }
  
        const environments = project.environments?.edges?.map(edge => edge.node) || [];
        const services = project.services?.edges?.map(edge => edge.node) || [];
  
        const environmentList = environments.map(env => 
          `  🌍 ${env.name} (ID: ${env.id})`
        ).join('\n');
  
        const serviceList = services.map(svc =>
          `  🚀 ${svc.name} (ID: ${svc.id})`
        ).join('\n');
  
        const info = `📁 Project: ${project.name} (ID: ${project.id})
  Description: ${project.description || 'No description'}
  Created: ${new Date(project.createdAt).toLocaleString()}
  Subscription: ${project.subscriptionType || 'Free'}
  
  Environments:
  ${environmentList || '  No environments'}
  
  Services:
  ${serviceList || '  No services'}`;
  
        return createSuccessResponse({
          text: info,
          data: { project, environments, services }
        });
      } catch (error) {
        return createErrorResponse(`Error getting project details: ${formatError(error)}`);
      }
    }

• src/tools/project.tool.ts:43-45 (schema)

  Zod input schema defining the required projectId parameter for the project_info tool.

  {
    projectId: z.string().describe("ID of the project to get information about")
  },

• src/tools/index.ts:32-36 (registration)

  The projectTools (including project_info) are spread into allTools and registered with the MCP server via server.tool().

  allTools.forEach((tool) => {
    server.tool(
      ...tool
    );
  });

• src/services/project.service.ts:136-136 (helper)

  Singleton instance of ProjectService exported for use by tool handlers.

  export const projectService = new ProjectService();