Skip to main content
Glama
TCSoftInc

TestCollab MCP Server

by TCSoftInc

get_suite

Retrieve test suite details including title, description, and metadata by specifying a suite ID. Use this tool to access comprehensive information about specific test suites in TestCollab projects.

Instructions

Get details of a specific test suite by ID. Returns the suite's title, description, parent_id, and other metadata.

Required: id (suite ID) Optional: project_id

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesSuite ID to retrieve (required)
project_idNoProject ID (optional if TC_DEFAULT_PROJECT is set)

Implementation Reference

  • The handler function `handleGetSuite` executes the logic to fetch a test suite by ID from the API client.
    export async function handleGetSuite(args: {
      id: number;
      project_id?: number;
    }): Promise<{ content: Array<{ type: "text"; text: string }> }> {
      try {
        const projectId = resolveProjectId(args.project_id);
        if (!projectId) {
          return {
            content: [
              {
                type: "text" as const,
                text: JSON.stringify({
                  error: {
                    code: "MISSING_PROJECT_ID",
                    message:
                      "No project_id provided and no default project configured. Set TC_DEFAULT_PROJECT or pass project_id.",
                  },
                }),
              },
            ],
          };
        }
    
        const client = getApiClient();
        const result = await client.getSuite(args.id, projectId);
    
        return {
          content: [
            {
              type: "text" as const,
              text: JSON.stringify({
                suite: result,
              }),
            },
          ],
        };
      } catch (error) {
        return {
          content: [
            {
              type: "text" as const,
              text: JSON.stringify({
                error: {
                  code: "GET_SUITE_FAILED",
                  message:
                    error instanceof Error ? error.message : "Unknown error",
                },
              }),
            },
          ],
        };
      }
    }
  • The schema definition for the `get_suite` tool inputs.
    export const getSuiteSchema = z.object({
      id: z.number().describe("Suite ID to retrieve (required)"),
      project_id: z
        .number()
        .optional()
        .describe("Project ID (optional if TC_DEFAULT_PROJECT is set)"),
    });
  • The tool definition including its name and description.
    export const getSuiteTool = {
      name: "get_suite",
      description: `Get details of a specific test suite by ID.
    Returns the suite's title, description, parent_id, and other metadata.
    
    Required: id (suite ID)
    Optional: project_id`,
    };

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/TCSoftInc/testcollab-mcp-server'

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