Skip to main content
Glama

github_codes_of_conduct_get_conduct_code

Retrieve a GitHub code of conduct by its key. This tool returns the full text, name, and URL of the code.

Instructions

Get a code of conduct

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYeskey

Implementation Reference

  • The handler for 'github_codes_of_conduct_get_conduct_code' that makes a GET request to /codes_of_conduct/{key} on the GitHub API. It accepts a 'key' path parameter and delegates to githubRequest.
    {
      name: "github_codes_of_conduct_get_conduct_code",
      description: "Get a code of conduct",
      inputSchema: z.object({
        key: z.string().describe("key")
      }),
      handler: async (args: Record<string, any>) => {
        return githubRequest("GET", `/codes_of_conduct/${args.key}`, undefined, undefined);
      },
  • The input schema for the tool, defining a required string parameter 'key' via Zod.
    inputSchema: z.object({
      key: z.string().describe("key")
    }),
  • src/index.ts:110-129 (registration)
    Registration of all tools (including this one) via server.tool() in the MCP server. The tool's name, description, schema shape, and handler are registered.
    for (const tool of allTools) {
      server.tool(
        tool.name,
        tool.description,
        tool.inputSchema.shape as any,
        async (args: any) => {
          try {
            const result = await tool.handler(args as any);
            return {
              content: [{ type: "text" as const, text: JSON.stringify(result, null, 2) }],
            };
          } catch (err) {
            const message = err instanceof Error ? err.message : String(err);
            return {
              content: [{ type: "text" as const, text: `Error: ${message}` }],
              isError: true,
            };
          }
        }
      );
  • The githubRequest helper function that executes the actual HTTP call to the GitHub API with auth headers.
    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?

Without annotations, the description carries the full burden of disclosing behavior. It only states 'Get a code of conduct', omitting details like whether it is read-only, error handling for invalid keys, rate limits, or return format. The behavioral transparency is minimal.

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

Conciseness3/5

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

The description is a single sentence, making it concise. However, its brevity comes at the cost of missing essential information that would help an agent use the tool correctly. It is not overly long, but it could be more informative without being verbose.

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 simple tool with one parameter, the description lacks completeness. It does not mention what the return value is, whether the key corresponds to a known code of conduct, or handling of missing keys. Without this context, the tool is minimally useful.

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

Parameters2/5

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

The input schema has one parameter 'key' with description 'key', which is a tautology. The description adds no additional meaning to the parameter's purpose, format, or acceptable values. Schema coverage is 100% but the descriptions are uninformative.

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 'Get a code of conduct' clearly indicates the action (get) and resource (code of conduct). However, it does not distinguish this tool from its sibling 'github_codes_of_conduct_get_all_codes_of_conduct', which also retrieves codes of conduct. Adding context like 'by key' would improve differentiation.

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?

The description provides no guidance on when to use this tool versus alternatives like 'get_all_codes_of_conduct'. There is no mention of prerequisites, context, or suitable scenarios, 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