Skip to main content
Glama

add_tests_to_test_set

Add test cases to an existing test set in Xray test management to organize and group related tests for execution.

Instructions

Add tests to an existing test set

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
testSetIssueIdYesThe test set issue ID (not key)
testIssueIdsYesArray of test issue IDs to add

Implementation Reference

  • Core handler function that executes the GraphQL mutation to add tests to a test set in Xray.
    async addTestsToTestSet(testSetIssueId: string, testIssueIds: string[]): Promise<any> {
      const mutation = `
        mutation AddTestsToTestSet($issueId: String!, $testIssueIds: [String]!) {
          addTestsToTestSet(issueId: $issueId, testIssueIds: $testIssueIds) {
            addedTests
            warning
          }
        }
      `;
    
      const variables = {
        issueId: testSetIssueId,
        testIssueIds
      };
    
      const result = await this.graphqlRequest<{ addTestsToTestSet: any }>(mutation, variables);
      return result.addTestsToTestSet;
    }
  • Tool schema definition including input validation for the add_tests_to_test_set tool.
    {
      name: 'add_tests_to_test_set',
      description: 'Add tests to an existing test set',
      inputSchema: {
        type: 'object',
        properties: {
          testSetIssueId: {
            type: 'string',
            description: 'The test set issue ID (not key)',
          },
          testIssueIds: {
            type: 'array',
            items: { type: 'string' },
            description: 'Array of test issue IDs to add',
          },
        },
        required: ['testSetIssueId', 'testIssueIds'],
      },
    },
  • src/index.ts:856-869 (registration)
    MCP server handler that registers and dispatches the tool call to the xrayClient implementation.
    case 'add_tests_to_test_set': {
      const result = await xrayClient.addTestsToTestSet(
        args.testSetIssueId as string,
        args.testIssueIds as string[]
      );
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(result, null, 2),
          },
        ],
      };
    }
  • Top-level MCP tool execution handler that calls the core implementation.
    case 'add_tests_to_test_set': {
      const result = await xrayClient.addTestsToTestSet(
        args.testSetIssueId as string,
        args.testIssueIds as string[]
      );
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(result, null, 2),
          },
        ],
      };
    }
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. It states this is an 'add' operation which implies mutation, but doesn't disclose permission requirements, whether this is reversible, rate limits, error conditions, or what happens if tests are already in the set. For a mutation tool with zero annotation coverage, this is insufficient.

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 with zero wasted words. It's appropriately sized for a straightforward tool and front-loads the essential information immediately.

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 mutation tool with no annotations and no output schema, the description is inadequate. It doesn't explain what the tool returns, error conditions, or behavioral characteristics. Given the complexity of modifying test sets and the lack of structured metadata, the description should provide more operational context.

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%, so the schema already fully documents both parameters. The description doesn't add any parameter semantics beyond what's in the schema - it doesn't explain what constitutes valid test set issue IDs versus test issue IDs, or provide examples. Baseline 3 is appropriate when schema does the heavy lifting.

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 ('Add tests') and target resource ('to an existing test set'), providing a specific verb+resource combination. However, it doesn't differentiate from the sibling tool 'add_tests_to_test_plan' which has a similar structure but different target resource, missing explicit sibling differentiation.

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 'add_tests_to_test_plan' or 'create_test_set'. It mentions 'existing test set' which implies a prerequisite but doesn't specify when this tool is appropriate versus creating a new test set or using other test management tools.

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