Skip to main content
Glama

get_copilot_seat_assignments

Retrieve GitHub Copilot seat assignments for an organization, showing user lists with last activity dates, editor information, and plan types.

Instructions

Get Copilot seat assignments for an Organization (user list with last activity date, editor info, plan type)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orgNoOrganization name (defaults to GITHUB_ORG env var)
force_refreshNoIgnore cache and fetch fresh data

Implementation Reference

  • The registration and handler implementation for the get_copilot_seat_assignments tool.
    export function registerSeatsTool(server: McpServer, client: GitHubClient, defaultOrg: string) {
      server.tool(
        "get_copilot_seat_assignments",
        "Get Copilot seat assignments for an Organization (user list with last activity date, editor info, plan type)",
        {
          org: z.string().optional().describe("Organization name (defaults to GITHUB_ORG env var)"),
          force_refresh: z.boolean().optional().describe("Ignore cache and fetch fresh data"),
        },
        async ({ org, 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 };
            }
    
            const seats = await client.fetchSeats(o, force_refresh ?? false);
    
            return { content: [{ type: "text", text: JSON.stringify(seats, null, 2) }] };
          } catch (error) {
            return { content: [{ type: "text", text: `Error: ${error instanceof Error ? error.message : String(error)}` }], isError: true };
          }
        }
      );
    }
Behavior2/5

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

With no annotations, the description carries full burden but lacks behavioral details. It mentions caching via 'force_refresh' parameter, but doesn't disclose permissions required, rate limits, error handling, or data freshness implications. This is a significant gap for a tool that likely involves sensitive organizational data.

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

Conciseness5/5

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

The description is a single, efficient sentence that front-loads the core purpose and key return details. There is no wasted text, making it easy for an agent to parse quickly.

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?

Given no annotations and no output schema, the description is incomplete. It doesn't explain the return format (e.g., structure of the user list), error cases, or authentication needs, which are critical for a tool that fetches organizational data. The schema covers inputs well, but overall context is lacking.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents both parameters ('org' and 'force_refresh') adequately. The description adds no additional parameter semantics beyond what's in the schema, meeting the baseline for high coverage.

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

Purpose4/5

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

The description clearly states the action ('Get') and resource ('Copilot seat assignments for an Organization'), specifying it returns a user list with last activity date, editor info, and plan type. It distinguishes from sibling tools by focusing on seat assignments rather than metrics or usage summaries, though it doesn't explicitly contrast them.

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 is provided on when to use this tool versus the sibling tools (e.g., get_copilot_metrics_for_org). The description implies it's for retrieving seat assignments, but it doesn't specify scenarios, prerequisites, or alternatives, leaving the agent to infer usage context.

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/tatsuyamiyazaki/copilot-usage-mcp'

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