railway-mcp

Instructions

Implementation Reference

• src/tools/project.tool.ts:77-79 (handler)

  The handler function for the 'project_create' tool. It receives name and optional teamId, then delegates to projectService.createProject.

  async ({ name, teamId }) => {
    return projectService.createProject(name, teamId);
  }

• src/tools/project.tool.ts:73-76 (schema)

  Zod input schema defining required 'name' (string) and optional 'teamId' (string) parameters for the project_create tool.

  {
    name: z.string().describe("Name for the new project"),
    teamId: z.string().optional().describe("Optional team ID to create the project under")
  },

• src/tools/index.ts:16-37 (registration)

  Registers all tools, including 'project_create' from projectTools array, to the MCP server using server.tool().

  export function registerAllTools(server: McpServer) {
    // Collect all tools
    const allTools = [
      ...databaseTools,
      ...deploymentTools,
      ...domainTools,
      ...projectTools,
      ...serviceTools,
      ...tcpProxyTools,
      ...variableTools,
      ...configTools,
      ...volumeTools,
      ...templateTools,
    ] as Tool[];
  
    // Register each tool with the server
    allTools.forEach((tool) => {
      server.tool(
        ...tool
      );
    });
  } 

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

  Helper service method that handles project creation API call, response formatting, and error handling.

  async createProject(name: string, teamId?: string): Promise<CallToolResult> {
    try {
      const project = await this.client.projects.createProject(name, teamId);
  
      return createSuccessResponse({
        text: `Created new project "${project.name}" (ID: ${project.id})`,
        data: project
      });
    } catch (error) {
      return createErrorResponse(`Error creating project: ${formatError(error)}`);
    }
  }

• src/api/repository/project.repo.ts:129-173 (helper)

  Repository helper performing the GraphQL mutation 'projectCreate' to create the project on Railway API.

  async createProject(name: string, teamId?: string): Promise<Project> {
    const data = await this.client.request<{ projectCreate: Project }>(`
      mutation projectCreate($name: String!, $teamId: String) {
        projectCreate(
        input: {
          name: $name,
          teamId: $teamId
        }) {
          id
          name
          description
          environments {
            edges {
              node {
                id
                name
              }
            }
            pageInfo {
              hasNextPage
              hasPreviousPage
            }
          }
          services {
            edges {
              node {
                id
                name
              }
            }
            pageInfo {
              hasNextPage
              hasPreviousPage
            }
          }
        }
      }
    `, { name, teamId });
  
    return {
      ...data.projectCreate,
      environments: data.projectCreate.environments || { edges: [], pageInfo: { hasNextPage: false, hasPreviousPage: false } },
      services: data.projectCreate.services || { edges: [], pageInfo: { hasNextPage: false, hasPreviousPage: false } }
    };
  }