get_copilot_metrics_for_team

Retrieve daily GitHub Copilot usage metrics for a specific team, including code completions, chat activity, and active user counts within a defined date range.

Instructions

Get daily Copilot usage metrics for a specific team within an Organization

Input Schema

TableJSON Schema

Name	Required	Description
`org`	No	Organization name (defaults to GITHUB_ORG env var)
`team_slug`	Yes	Team slug (required)
`since`	No	Start date in YYYY-MM-DD format (defaults to 28 days ago)
`until`	No	End date in YYYY-MM-DD format (defaults to today)
`force_refresh`	No	Ignore cache and fetch fresh data

Implementation Reference

src/tools/team.ts:17-40 (handler)

The handler function that executes the logic for 'get_copilot_metrics_for_team', including parameter validation and client data fetching.

async ({ org, team_slug, since, until, force_refresh }) => {
  try {
    const o = org ?? defaultOrg;
    if (!o) {
      return { content: [{ type: "text", text: "Organization name is required. Set GITHUB_ORG or pass 'org' parameter." }], isError: true };
    }
    validateTeamSlug(team_slug);

    const today = new Date().toISOString().split("T")[0];
    const defaultSince = new Date();
    defaultSince.setUTCDate(defaultSince.getUTCDate() - 28);
    const s = since ?? defaultSince.toISOString().split("T")[0];
    const u = until ?? today;

    validateDateRange(s, u);

    const cacheSlug = `${o}/${team_slug}`;
    const metrics = await client.fetchMetrics("team", cacheSlug, s, u, force_refresh ?? false, { identifier: o, teamSlug: team_slug });

    return { content: [{ type: "text", text: JSON.stringify(metrics, null, 2) }] };
  } catch (error) {
    return { content: [{ type: "text", text: `Error: ${error instanceof Error ? error.message : String(error)}` }], isError: true };
  }
}

src/tools/team.ts:10-16 (schema)

The Zod schema definition for input parameters of 'get_copilot_metrics_for_team'.

{
  org: z.string().optional().describe("Organization name (defaults to GITHUB_ORG env var)"),
  team_slug: z.string().describe("Team slug (required)"),
  since: z.string().optional().describe("Start date in YYYY-MM-DD format (defaults to 28 days ago)"),
  until: z.string().optional().describe("End date in YYYY-MM-DD format (defaults to today)"),
  force_refresh: z.boolean().optional().describe("Ignore cache and fetch fresh data"),
},

src/tools/team.ts:7-41 (registration)

The tool registration call within 'registerTeamTool'.

server.tool(
  "get_copilot_metrics_for_team",
  "Get daily Copilot usage metrics for a specific team within an Organization",
  {
    org: z.string().optional().describe("Organization name (defaults to GITHUB_ORG env var)"),
    team_slug: z.string().describe("Team slug (required)"),
    since: z.string().optional().describe("Start date in YYYY-MM-DD format (defaults to 28 days ago)"),
    until: z.string().optional().describe("End date in YYYY-MM-DD format (defaults to today)"),
    force_refresh: z.boolean().optional().describe("Ignore cache and fetch fresh data"),
  },
  async ({ org, team_slug, since, until, force_refresh }) => {
    try {
      const o = org ?? defaultOrg;
      if (!o) {
        return { content: [{ type: "text", text: "Organization name is required. Set GITHUB_ORG or pass 'org' parameter." }], isError: true };
      }
      validateTeamSlug(team_slug);

      const today = new Date().toISOString().split("T")[0];
      const defaultSince = new Date();
      defaultSince.setUTCDate(defaultSince.getUTCDate() - 28);
      const s = since ?? defaultSince.toISOString().split("T")[0];
      const u = until ?? today;

      validateDateRange(s, u);

      const cacheSlug = `${o}/${team_slug}`;
      const metrics = await client.fetchMetrics("team", cacheSlug, s, u, force_refresh ?? false, { identifier: o, teamSlug: team_slug });

      return { content: [{ type: "text", text: JSON.stringify(metrics, null, 2) }] };
    } catch (error) {
      return { content: [{ type: "text", text: `Error: ${error instanceof Error ? error.message : String(error)}` }], isError: true };
    }
  }
);

copilot-usage-mcp