Skip to main content
Glama
simplypixi

BugBug MCP Server

by simplypixi

get_suite_run_status

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

Instructions

Get current status of a BugBug suite run

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
runIdYesSuite run UUID

Implementation Reference

  • The complete tool object definition for 'get_suite_run_status', including the handler function that executes the tool logic by calling the bugbugClient API and formatting the response.
    export const getSuiteRunStatusTool: Tool = {
      name: 'get_suite_run_status',
      title: 'Get current status of a BugBug suite run',
      description: 'Get current status of a BugBug suite run',
      inputSchema: z.object({
        runId: z.string().describe('Suite run UUID'),
      }).shape,
      handler: async ({ runId }) => {
          try {
    
            const statusResponse = await bugbugClient.getSuiteRunStatus(runId);
            
            if (statusResponse.status !== 200) {
              return {
                content: [
                  {
                    type: 'text',
                    text: `Error: ${statusResponse.status} ${statusResponse.statusText}`,
                  },
                ],
              };
            }
    
            const status = statusResponse.data;
            
            return {
              content: [
                {
                  type: 'text',
                  text: `**Suite 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 suite run status: ${error instanceof Error ? error.message : 'Unknown error'}`,
                },
              ],
            };
          }
        }
    };
  • Zod input schema for the tool, validating the runId parameter.
    inputSchema: z.object({
      runId: z.string().describe('Suite run UUID'),
    }).shape,
  • Registration function that registers all tools, including get_suite_run_status from suiteRunsTools, using MCP 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)
        );
      }
    }
  • Helper method in BugBugApiClient that makes the API request to retrieve suite run status.
    async getSuiteRunStatus(id: string): Promise<ApiResponse<BugBugRunStatusResponse>> {
      return this.makeRequest(`/suiteruns/${id}/status/`);
    }
  • src/tools/index.ts:7-7 (registration)
    Import of suiteRuns tools module containing the getSuiteRunStatusTool.
    import * as suiteRunsTools from './suiteRuns.js';
Behavior3/5

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

Annotations only provide a title that repeats the description, offering no behavioral hints. The description itself doesn't disclose any behavioral traits beyond the basic operation - no information about authentication requirements, rate limits, error conditions, or what format the status information returns. It's minimally adequate but lacks important operational context.

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 perfectly concise - a single sentence that communicates the essential purpose without any wasted words. It's front-loaded with the core functionality and contains no unnecessary information.

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

Completeness3/5

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

For a simple status-checking tool with one parameter and no output schema, the description is minimally complete. However, it doesn't explain what 'status' means in this context (running, completed, failed, etc.) or what information the tool returns, which would be helpful given the lack of output schema.

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 already fully documents the single 'runId' parameter as a 'Suite run UUID'. The description adds no additional parameter semantics beyond what's in the schema, so it meets the baseline expectation but doesn't provide extra value.

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 action ('Get current status') and target resource ('BugBug suite run'), making the purpose immediately understandable. However, it doesn't differentiate this tool from its sibling 'get_test_run_status' or explain what distinguishes a 'suite run' from a 'test run' in this context.

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 about when to use this tool versus alternatives like 'get_suite_run' (which might return different information) or 'get_test_run_status' (for test runs rather than suite runs). There's no mention of prerequisites, timing considerations, or typical use cases.

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