Skip to main content
Glama

get_test_case

Retrieve detailed information about a specific test case using its unique key, such as PROJ-123, to support test management and automation workflows.

Instructions

Get details of a specific test case by key

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
testKeyYesThe test case key (e.g., "PROJ-123")

Implementation Reference

  • Core handler function that executes the GraphQL query to retrieve detailed test case information from Xray Cloud by test key.
    async getTestCase(testKey: string): Promise<any> {
      const query = `
        query GetTest($jql: String!, $limit: Int!) {
          getTests(jql: $jql, limit: $limit) {
            total
            results {
              issueId
              projectId
              jira(fields: ["key", "summary", "description", "priority", "status", "labels"])
              testType {
                name
                kind
              }
              steps {
                id
                action
                data
                result
              }
              gherkin
              unstructured
            }
          }
        }
      `;
    
      const variables = {
        jql: `key = '${testKey}'`,
        limit: 1
      };
    
      const result = await this.graphqlRequest<{ getTests: any }>(query, variables);
    
      if (result.getTests.total === 0) {
        throw new Error(`Test case ${testKey} not found`);
      }
    
      return result.getTests.results[0];
    }
  • MCP server tool call handler that invokes the XrayClient.getTestCase method and formats the response.
    case 'get_test_case': {
      const result = await xrayClient.getTestCase(args.testKey as string);
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(result, null, 2),
          },
        ],
      };
    }
  • Tool schema definition including input validation for testKey parameter.
    {
      name: 'get_test_case',
      description: 'Get details of a specific test case by key',
      inputSchema: {
        type: 'object',
        properties: {
          testKey: {
            type: 'string',
            description: 'The test case key (e.g., "PROJ-123")',
          },
        },
        required: ['testKey'],
      },
    },
  • src/index.ts:519-521 (registration)
    Registration of the tools list handler that exposes all tools including get_test_case to MCP clients.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return { tools };
    });
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. While 'Get details' suggests a read operation, it doesn't specify whether this requires authentication, what format/details are returned, if there are rate limits, or error conditions. For a tool with zero annotation coverage, this is inadequate behavioral transparency.

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 gets straight to the point with no wasted words. It's appropriately sized for a simple lookup tool and front-loads the essential information.

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?

For a tool with no annotations, no output schema, and multiple sibling tools that perform similar functions, the description is insufficiently complete. It doesn't explain what 'details' are returned, how this differs from other test case retrieval tools, or provide any context about authentication requirements or error handling.

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 'testKey' well-documented in the schema. The description adds minimal value beyond the schema by mentioning 'by key' which is already implied. With high schema coverage, the baseline score of 3 is appropriate as the description doesn't significantly enhance parameter understanding.

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 details') and resource ('specific test case by key'), making the purpose immediately understandable. However, it doesn't differentiate from siblings like 'search_test_cases' or 'get_project_test_cases' that also retrieve test case information, so it doesn't reach the highest clarity level.

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 like 'search_test_cases' or 'get_project_test_cases'. It mentions 'specific test case by key' which implies you need the exact key, but doesn't explicitly state this as a distinguishing factor or mention when other tools would be more appropriate.

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/c4m3lblue-star/xray-mcp'

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