QA Studio MCP Server

Instructions

Implementation Reference

• src/index.ts:152-177 (handler)

  The handler function for the 'list-test-runs' tool. It destructures args for projectId, limit (default 50), offset (default 0), calls apiRequest to fetch test runs from the QA Studio API, returns JSON stringified data or error.

  async (args) => {
    try {
      const { projectId, limit = 50, offset = 0 } = args;
  
      const data = await apiRequest(`/runs?projectId=${projectId}&limit=${limit}&offset=${offset}`);
  
      return {
        content: [
          {
            type: 'text' as const,
            text: JSON.stringify(data, null, 2)
          }
        ]
      };
    } catch (error) {
      return {
        content: [
          {
            type: 'text' as const,
            text: `Error: ${error instanceof Error ? error.message : String(error)}`
          }
        ],
        isError: true
      };
    }
  }

• src/index.ts:141-151 (schema)

  The input schema for the 'list-test-runs' tool using Zod, requiring projectId and optional limit/offset for pagination.

  {
    description: 'List test runs for a project',
    inputSchema: {
      projectId: z.string().describe('The project ID to list test runs for'),
      limit: z.number().optional().describe('Maximum number of results to return (default: 50)'),
      offset: z
        .number()
        .optional()
        .describe('Number of results to skip for pagination (default: 0)')
    }
  },

• src/index.ts:139-178 (registration)

  The full registration of the 'list-test-runs' tool via server.registerTool, specifying the tool name, input schema, and inline handler function.

  server.registerTool(
    'list-test-runs',
    {
      description: 'List test runs for a project',
      inputSchema: {
        projectId: z.string().describe('The project ID to list test runs for'),
        limit: z.number().optional().describe('Maximum number of results to return (default: 50)'),
        offset: z
          .number()
          .optional()
          .describe('Number of results to skip for pagination (default: 0)')
      }
    },
    async (args) => {
      try {
        const { projectId, limit = 50, offset = 0 } = args;
  
        const data = await apiRequest(`/runs?projectId=${projectId}&limit=${limit}&offset=${offset}`);
  
        return {
          content: [
            {
              type: 'text' as const,
              text: JSON.stringify(data, null, 2)
            }
          ]
        };
      } catch (error) {
        return {
          content: [
            {
              type: 'text' as const,
              text: `Error: ${error instanceof Error ? error.message : String(error)}`
            }
          ],
          isError: true
        };
      }
    }
  );

• src/index.ts:17-34 (helper)

  Shared apiRequest helper function used by the list-test-runs handler (and other tools) to perform authenticated API requests to the QA Studio backend.

  async function apiRequest(endpoint: string, options: RequestInit = {}): Promise<any> {
    const url = `${API_URL}${endpoint}`;
    const response = await fetch(url, {
      ...options,
      headers: {
        'Content-Type': 'application/json',
        'X-API-Key': API_KEY,
        ...options.headers
      }
    });
  
    if (!response.ok) {
      const error = await response.text();
      throw new Error(`API Error (${response.status}): ${error}`);
    }
  
    return response.json();
  }