codebeamer-mcp

Instructions

Implementation Reference

• src/tools/trackers.ts:41-44 (handler)

  The handler for "list_trackers" which calls the client's listTrackers method and formats the result.

  async ({ projectId, page, pageSize }) => {
    const result = await client.listTrackers(projectId, page, pageSize);
    return { content: [{ type: "text", text: formatTrackerList(result) }] };
  },

• src/tools/trackers.ts:13-45 (registration)

  Registration of the "list_trackers" tool, including its input schema.

  server.registerTool(
    "list_trackers",
    {
      title: "List Trackers",
      description:
        "List all trackers (Requirements, Bugs, Test Cases, etc.) in a Codebeamer project. " +
        "Use the returned tracker IDs to list items or get tracker details.",
      inputSchema: {
        projectId: z
          .number()
          .int()
          .positive()
          .describe("Numeric project ID"),
        page: z
          .number()
          .int()
          .min(1)
          .default(1)
          .describe("Page number (starts at 1)"),
        pageSize: z
          .number()
          .int()
          .min(1)
          .max(100)
          .default(25)
          .describe("Items per page (max 100)"),
      },
    },
    async ({ projectId, page, pageSize }) => {
      const result = await client.listTrackers(projectId, page, pageSize);
      return { content: [{ type: "text", text: formatTrackerList(result) }] };
    },
  );

• src/client/codebeamer-client.ts:194-204 (handler)

  The underlying client method that performs the API call to list trackers.

  async listTrackers(
    projectId: number,
    page: number,
    pageSize: number,
  ): Promise<CbTracker[]> {
    const raw = await this.http.get<unknown>(`/projects/${projectId}/trackers`, {
      params: { page, pageSize },
      resource: `trackers for project ${projectId}`,
    });
    return toArray(raw);
  }