Skip to main content
Glama
simplypixi

BugBug MCP Server

by simplypixi

get_test_run_status

Check the current execution status of a BugBug test run by providing its unique identifier to monitor progress and completion.

Instructions

Get current status of a BugBug test run

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
runIdYesTest run UUID

Implementation Reference

  • The async handler function for the 'get_test_run_status' tool. It fetches the test run status using bugbugClient and returns a formatted text response with status details or error.
    handler: async ({ runId }) => {
        try {
    
          const statusResponse = await bugbugClient.getTestRunStatus(runId);
          
          if (statusResponse.status !== 200) {
            return {
              content: [
                {
                  type: 'text',
                  text: `Error: ${statusResponse.status} ${statusResponse.statusText}`,
                },
              ],
            };
          }
    
          const status = statusResponse.data;
          
          return {
            content: [
              {
                type: 'text',
                text: `**Test Run Status:**\n\n- **ID:** ${status.id}\n- **Status:** ${status.status}\n- **Last Modified:** ${status.modified}\n- **Web App URL:** ${status.webappUrl}`,
              },
            ],
          };
        } catch (error) {
          return {
            content: [
              {
                type: 'text',
                text: `Error fetching test run status: ${error instanceof Error ? error.message : 'Unknown error'}`,
              },
            ],
          };
        }
      }
  • Zod input schema defining the required 'runId' parameter as a string.
    inputSchema: z.object({
      runId: z.string().describe('Test run UUID'),
    }).shape,
  • The registerAllTools function imports testRunsTools (containing getTestRunStatusTool) and registers it along with other tools on the MCP server using server.registerTool.
    export function registerAllTools(server: McpServer): void {
      const tools: Record<string, Tool> = {
        ...configTools,
        ...testsTools,
        ...testRunsTools,
        ...suitesTools,
        ...suiteRunsTools,
        ...profilesTools,
        ...advancedTools,
      };
    
      for (const t in tools) {
        server.registerTool(
          tools[t].name,
          {
            description: tools[t].description,
            inputSchema: tools[t].inputSchema,
            annotations: { title: tools[t].title },
          },
          (args: unknown) => tools[t].handler(args as unknown)
        );
      }
    }
  • The BugBugApiClient.getTestRunStatus helper method that makes the API GET request to retrieve the test run status from '/testruns/{id}/status/'.
    async getTestRunStatus(id: string): Promise<ApiResponse<BugBugRunStatusResponse>> {
      return this.makeRequest(`/testruns/${id}/status/`);
    }
Behavior3/5

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

Annotations provide a title but no behavioral hints (e.g., readOnlyHint, destructiveHint). The description adds minimal behavioral context beyond the title, stating it retrieves 'current status' but not explaining what that status entails, response format, or any limitations like rate limits or authentication needs. It doesn't contradict annotations, but offers little additional value.

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 a single, direct sentence with zero wasted words. It's front-loaded with the core action and resource, making it highly efficient and easy to parse.

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

Completeness2/5

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

Given the lack of annotations and output schema, the description is insufficiently complete. It doesn't explain what the status output includes, potential error conditions, or how it differs from related tools, leaving gaps for a tool that likely returns structured status information.

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?

With 100% schema description coverage, the input schema fully documents the single parameter 'runId' as a 'Test run UUID'. The description adds no parameter-specific information beyond what's in the schema, so it meets the baseline for adequate but unenlightening coverage.

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

Purpose4/5

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

The description clearly states the verb ('Get') and resource ('current status of a BugBug test run'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'get_test_run' or 'get_test_run_screenshots', which prevents a perfect score.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. With siblings like 'get_test_run' and 'wait_for_test_run' that might serve similar purposes, there's no indication of when this specific status-checking tool is appropriate or what distinguishes it.

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/simplypixi/bugbug-mcp-server'

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