Skip to main content
Glama
simplypixi

BugBug MCP Server

by simplypixi

get_suite

Retrieve detailed information about a specific BugBug test suite using its unique identifier to access configuration, test cases, and metadata.

Instructions

Get details of a specific BugBug test suite

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
suiteIdYesSuite UUID

Implementation Reference

  • Full implementation of the 'get_suite' tool: defines the tool with name, input schema for suiteId, and handler that fetches the suite details using bugbugClient.getSuite and returns formatted MCP text content.
    export const getSuiteTool: Tool = {
      name: 'get_suite',
      title: 'Get details of a specific BugBug test suite',
      description: 'Get details of a specific BugBug test suite',
      inputSchema: z.object({
        suiteId: z.string().describe('Suite UUID'),
      }).shape,
      handler: async ({ suiteId }) => {
          try {
            const response = await bugbugClient.getSuite(suiteId);
            
            if (response.status !== 200) {
              return {
                content: [
                  {
                    type: 'text',
                    text: `Error: ${response.status} ${response.statusText}`,
                  },
                ],
              };
            }
    
            const suite = response.data;
            
            return {
              content: [
                {
                  type: 'text',
                  text: `**Suite Details:**\n\n- **Name:** ${suite.name || 'Unnamed Suite'}\n- **ID:** ${suite.id}\n- **Tests Count:** ${suite.testsCount || 0}`,
                },
              ],
            };
          } catch (error) {
            return {
              content: [
                {
                  type: 'text',
                  text: `Error fetching suite: ${error instanceof Error ? error.message : 'Unknown error'}`,
                },
              ],
            };
          }
        }
    };
  • Input schema for 'get_suite' tool using Zod: requires suiteId as string.
    inputSchema: z.object({
      suiteId: z.string().describe('Suite UUID'),
    }).shape,
  • Registers all tools including 'get_suite' (from suitesTools import) with the MCP server by iterating over the tools record and calling server.registerTool with name, schema, and handler wrapper.
    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)
        );
      }
    }
Behavior3/5

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

Annotations provide a title that matches the description's purpose, but no behavioral hints (e.g., readOnlyHint, destructiveHint) are present. The description adds minimal behavioral context beyond stating it retrieves details, without addressing aspects like authentication needs, rate limits, or response format, which is inadequate given the lack of annotations.

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, efficient sentence that directly states the tool's purpose without unnecessary words. It's front-loaded and wastes no space, making it easy to parse quickly.

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 'details' include (e.g., suite configuration, test cases), potential errors, or how to interpret results, leaving gaps for a tool that likely returns structured data about a suite.

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?

Schema description coverage is 100%, with the single parameter 'suiteId' documented as 'Suite UUID'. The description doesn't add any semantic details beyond what the schema provides, such as format examples or where to find the UUID, so it meets the baseline but offers no 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 verb ('Get details') and resource ('BugBug test suite'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'get_suites' (plural) or 'get_suite_run' which retrieves run information rather than suite details, missing full sibling distinction.

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. It doesn't mention prerequisites like needing a suite ID, nor does it compare to siblings like 'get_suites' for listing all suites or 'get_suite_run' for run-specific details, leaving usage context unclear.

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