MCP Zephyr

Instructions

Implementation Reference

• src/tools/project-tools.js:52-80 (handler)

  The handler function for the 'get_project' tool. It extracts the projectId from arguments, fetches the project details using ZephyrClient.getProject, formats the response as JSON text, and handles errors appropriately.

  async function getProject(args) {
    try {
      const { projectId } = args;
      if (!projectId) {
        throw new Error('projectId is required');
      }
  
      const project = await client.getProject(projectId);
  
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(project, null, 2)
          }
        ]
      };
    } catch (error) {
      return {
        content: [
          {
            type: 'text',
            text: formatError(error, `fetching project ${args.projectId}`)
          }
        ],
        isError: true
      };
    }
  }

• src/tools/project-tools.js:106-121 (registration)

  Registration of the 'get_project' tool within the projectTools array export. Specifies name, description, input schema, and references the handler function.

  {
    name: 'get_project',
    description: 'Get detailed information about a specific Zephyr project',
    inputSchema: {
      type: 'object',
      properties: {
        projectId: {
          type: 'string',
          description: 'Project ID or key to retrieve',
          pattern: '^[A-Z][A-Z_0-9]+$|^\\d+$'
        }
      },
      required: ['projectId']
    },
    handler: getProject
  }

• src/tools/project-tools.js:109-119 (schema)

  Input schema definition for the 'get_project' tool, validating the required projectId parameter with regex pattern for project keys or numeric IDs.

  inputSchema: {
    type: 'object',
    properties: {
      projectId: {
        type: 'string',
        description: 'Project ID or key to retrieve',
        pattern: '^[A-Z][A-Z_0-9]+$|^\\d+$'
      }
    },
    required: ['projectId']
  },

• src/index.js:30-37 (registration)

  Main registration in src/index.js where projectTools (including get_project) are spread into the allTools array used by the MCP server for tool handling.

  const allTools = [
    ...projectTools,
    ...folderTools,
    ...testCaseTools,
    ...testStepsTools,
    ...testScriptTools,
    ...referenceDataTools
  ];