Skip to main content
Glama

create-module

Creates a new module in qTest Test Design to organize test cases under a project, optionally as a submodule under a parent module.

Instructions

Test Design — create a new module in qTest Test Design to organise test cases

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYes
nameYesName of the new module
parentIdNoParent module ID; omit to create at root

Implementation Reference

  • The core handler function that executes the create-module logic. It constructs the API endpoint (with optional parentId for sub-module or root), sends a POST request via qtestFetch, and returns the created module as a QTestModule.
    export async function createModule(args: CreateModuleArgs): Promise<QTestModule> {
      const { projectId, name, parentId } = args
      const endpoint =
        parentId !== undefined
          ? `/modules?parentId=${parentId}&parentType=module`
          : `/modules?parentType=root`
    
      const result = await qtestFetch(config, projectId, endpoint, 'POST', { name })
      return result as QTestModule
  • TypeScript interface defining the input schema for createModule: projectId (string), name (string), and optional parentId (number).
    export interface CreateModuleArgs {
      projectId: string
      name: string
      parentId?: number
    }
  • src/server.ts:61-75 (registration)
    Registration of the 'create-module' tool on the MCP server, including its description, Zod input schema, and the inline async handler that calls createModule.
    server.registerTool(
      'create-module',
      {
        description: 'Test Design — create a new module in qTest Test Design to organise test cases',
        inputSchema: {
          projectId: z.string(),
          name: z.string().describe('Name of the new module'),
          parentId: z.number().int().optional().describe('Parent module ID; omit to create at root'),
        },
      },
      async ({ projectId, name, parentId }) => {
        const result = await createModule({ projectId, name, parentId })
        return { content: [{ type: 'text' as const, text: JSON.stringify(result, null, 2) }] }
      }
    )
Behavior2/5

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

No annotations exist, so description must fully disclose behavior. It only says 'create' without mentioning idempotency, permissions, duplicates handling, or side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence is concise, but the prefix 'Test Design —' is slightly unclear. Front-loads purpose efficiently.

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?

No output schema, no annotations, and minimal description. Lacks information on success/failure, error conditions, constraints, or return values, leaving gaps for a mutable tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 67% but the description adds no parameter details. Missing description for projectId is not compensated. Schema already documents name and parentId, so description adds no value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action (create) and the resource (new module) with context (in qTest Test Design to organise test cases), distinguishing it from sibling tools that do other operations.

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?

No guidance on when to use this tool vs alternatives like add-test-cases or create-test-cycle. No exclusion criteria or prerequisites provided.

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/Usman-Ghani123/qtest-mcp-server'

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