Skip to main content
Glama

github_codespaces_get_public_key_for_authenticated_user

Retrieve the public key for the authenticated user, enabling encrypted data operations in GitHub Codespaces.

Instructions

Get public key for the authenticated user

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler function for 'github_codespaces_get_public_key_for_authenticated_user' tool. Makes a GET request to `/user/codespaces/secrets/public-key` with no body or query parameters.
    {
      name: "github_codespaces_get_public_key_for_authenticated_user",
      description: "Get public key for the authenticated user",
      inputSchema: z.object({}),
      handler: async (args: Record<string, any>) => {
        return githubRequest("GET", `/user/codespaces/secrets/public-key`, undefined, undefined);
      },
    },
  • Input schema for the tool - empty object (z.object({})), meaning no input parameters are required.
    name: "github_codespaces_get_public_key_for_authenticated_user",
    description: "Get public key for the authenticated user",
    inputSchema: z.object({}),
  • The tool is part of the exported `codespacesTools` array, which is imported and registered in src/index.ts via `server.tool()` on line 111.
    export const codespacesTools = [
  • The `githubRequest` helper function that performs the actual HTTP request to the GitHub API. Used by the handler to make a GET request to the GitHub API endpoint.
    export async function githubRequest<T>(
      method: string,
      path: string,
      body?: Record<string, unknown>,
      params?: Record<string, string | number | boolean | string[] | undefined>
    ): Promise<T> {
      const url = new URL(`${BASE_URL}${path}`);
    
      if (params) {
        for (const [key, value] of Object.entries(params)) {
          if (value === undefined || value === null || value === "") continue;
          if (Array.isArray(value)) {
            url.searchParams.set(key, value.join(","));
          } else {
            url.searchParams.set(key, String(value));
          }
        }
      }
    
      const headers: Record<string, string> = {
        Authorization: `Bearer ${getToken()}`,
        Accept: "application/vnd.github+json",
        "X-GitHub-Api-Version": "2022-11-28",
        "User-Agent": "github-mcp/1.0.0",
      };
    
      if (body) {
        headers["Content-Type"] = "application/json";
      }
    
      const res = await fetch(url.toString(), {
        method,
        headers,
        body: body ? JSON.stringify(body) : undefined,
      });
    
      if (!res.ok) {
        const text = await res.text().catch(() => "");
        let detail = text;
        try {
          const json = JSON.parse(text);
          detail = json.message || text;
          if (json.errors) detail += ` -- ${JSON.stringify(json.errors)}`;
        } catch {}
        throw new Error(`GitHub API error ${res.status}: ${detail}`);
      }
    
      if (res.status === 204) return {} as T;
    
      return res.json() as Promise<T>;
Behavior2/5

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

No annotations are provided, so the description must cover behavioral traits. It only states it's for the authenticated user, implying authentication, but does not disclose if it's a read-only operation, rate limits, or any side effects. The lack of detail forces reliance on implicit understanding.

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, concise sentence that directly conveys the tool's purpose with no unnecessary words. It is front-loaded and efficient.

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?

For a tool with no output schema, the description does not describe the return value (e.g., the public key string or object). It also does not mention any related context, such as encryption usage or key rotation. Given the tool's simplicity, it is somewhat adequate but lacks details a new user might need.

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?

The input schema has no parameters, so the description does not add meaning beyond what the schema provides. With 100% schema coverage, a baseline of 3 is appropriate, but the description could explain what the public key is used for (e.g., encrypting secrets), which is absent.

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 public key' and the target 'for the authenticated user', which is specific and unambiguous. However, it does not differentiate from sibling tools that also retrieve public keys for different contexts (e.g., repos, orgs), but the name itself distinguishes it.

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 versus alternatives like getting a repo or org public key. There is no mention of prerequisites, typical use cases, or exclusions, leaving the agent to infer usage from the name alone.

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/Eyalm321/github-mcp'

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