Portkey MCP Server

Instructions

Implementation Reference

• src/index.ts:149-184 (handler)

  The main handler function for the 'get_workspace' MCP tool. It extracts workspace_id from params, calls portkeyService.getWorkspace, formats the response including users list, and handles errors.

    async (params) => {
      try {
        const workspace = await portkeyService.getWorkspace(params.workspace_id);
        return {
          content: [{ 
            type: "text", 
            text: JSON.stringify({
              id: workspace.id,
              name: workspace.name,
              slug: workspace.slug,
              description: workspace.description,
              created_at: workspace.created_at,
              last_updated_at: workspace.last_updated_at,
              defaults: workspace.defaults,
              users: workspace.users.map(user => ({
                id: user.id,
                name: `${user.first_name} ${user.last_name}`,
                organization_role: user.org_role,
                workspace_role: user.role,
                status: user.status,
                created_at: user.created_at,
                last_updated_at: user.last_updated_at
              }))
            }, null, 2)
          }]
        };
      } catch (error) {
        return {
          content: [{ 
            type: "text", 
            text: `Error fetching workspace details: ${error instanceof Error ? error.message : 'Unknown error'}`
          }]
        };
      }
    }
  );

• src/index.ts:143-148 (schema)

  Zod input schema validating the required 'workspace_id' parameter for the get_workspace tool.

  {
    workspace_id: z.string().describe(
      "The unique identifier of the workspace to retrieve. " +
      "This can be found in the workspace's URL or from the list_workspaces tool response"
    )
  },

• src/index.ts:140-142 (registration)

  Registration of the 'get_workspace' tool with the MCP server, specifying name and description.

  server.tool(
    "get_workspace",
    "Retrieve detailed information about a specific workspace, including its configuration, metadata, and user access details",

• src/services/portkey.service.ts:407-426 (helper)

  Helper method in PortkeyService that makes the API call to retrieve single workspace details from Portkey API.

  async getWorkspace(workspaceId: string): Promise<SingleWorkspaceResponse> {
    try {
      const response = await fetch(`${this.baseUrl}/admin/workspaces/${workspaceId}`, {
        method: 'GET',
        headers: {
          'x-portkey-api-key': this.apiKey,
          'Accept': 'application/json'
        }
      });
  
      if (!response.ok) {
        throw new Error(`HTTP error! status: ${response.status}`);
      }
  
      return await response.json() as SingleWorkspaceResponse;
    } catch (error) {
      console.error('PortkeyService Error:', error);
      throw new Error('Failed to fetch workspace details from Portkey API');
    }
  }

• src/services/portkey.service.ts:127-140 (schema)

  TypeScript interface defining the structure of the SingleWorkspaceResponse returned by the getWorkspace service method.

  interface SingleWorkspaceResponse {
    id: string;
    name: string;
    slug: string;
    description: string | null;
    created_at: string;
    last_updated_at: string;
    defaults: {
      is_default: number;
      metadata: Record<string, string>;
      object: 'workspace';
    } | null;
    users: WorkspaceUser[];
  }