github_get_code

Instructions

Implementation Reference

• src/index.ts:86-124 (handler)

  The main handler for the 'github_get_code' tool. It parses arguments using GithubUrlSchema, calls fetch on the URL built by buildWorkerUrl, and returns the response text as the tool output.

  case 'github_get_code': {
    const parsed = GithubUrlSchema.safeParse(args);
    if (!parsed.success) {
      throw new Error(
        `Invalid arguments for github_get_code: ${parsed.error}`
      );
    }
  
    try {
      const response = await fetch(buildWorkerUrl(parsed.data));
  
      if (!response.ok) {
        throw new Error(`HTTP error! status: ${response.status}`);
      }
  
      const text = await response.text();
  
      return {
        content: [
          {
            type: 'text',
            text,
          },
        ],
      };
    } catch (error) {
      const errorMessage =
        error instanceof Error ? error.message : String(error);
      return {
        content: [
          {
            type: 'text',
            text: `API Error: ${errorMessage}`,
          },
        ],
        isError: true,
      };
    }
  }

• src/githubTool.ts:5-12 (schema)

  The Zod schema (GithubUrlSchema) used for validating inputs to the github_get_code tool. Defines fields: url (required), dir, ext, mode, branch, file (all optional).

  export const GithubUrlSchema = z.object({
    url: z.string().url(),
    dir: z.string().optional(),
    ext: z.string().optional(),
    mode: z.enum(['tree']).optional(),
    branch: z.string().optional(),
    file: z.string().optional(),
  });

• src/githubTool.ts:16-26 (helper)

  Helper function that builds a worker URL by appending query parameters (dir, ext, mode, branch, file) to the base worker URL.

  export const buildWorkerUrl = (params: GithubWorkerRequest): string => {
    const url = new URL(`${WORKER_BASE_URL}${params.url}`);
  
    if (params.dir) url.searchParams.set('dir', params.dir);
    if (params.ext) url.searchParams.set('ext', params.ext);
    if (params.mode) url.searchParams.set('mode', params.mode);
    if (params.branch) url.searchParams.set('branch', params.branch);
    if (params.file) url.searchParams.set('file', params.file);
  
    return url.toString();
  };

• src/index.ts:33-77 (registration)

  Registration of the 'github_get_code' tool via ListToolsRequestSchema handler. Defines the tool's name, description, and inputSchema (converted from GithubUrlSchema via zodToJsonSchema).

  server.setRequestHandler(ListToolsRequestSchema, async () => {
    const tools = [
      {
        name: 'github_get_code',
        description: `
  Retrieves code from a GitHub repository URL and combines it into a single file. The URL must start with "https://".
  
  Query Parameters:
  - dir: Filter files by directory paths (comma-separated)
    Example: ?dir=src/components,tests/unit
  - ext: Filter files by extensions (comma-separated)
    Example: ?ext=ts,tsx,js
  - mode: Display mode
    Example: ?mode=tree (Shows directory structure and README files only)
  - branch: Specify the branch to fetch from (optional)
    Example: ?branch=feature/new-feature
  - file: Specify a single file to retrieve (optional)
    Example: ?file=src/components/Button.tsx
  
  Examples:
  1. For GitHub tree URLs with branch:
    https://github.com/kazuph/pera1/tree/feature/great-branch
    This URL will be automatically parsed to extract the branch information.
  
  2. For specific directory in a branch:
    url: https://github.com/modelcontextprotocol/servers
    dir: src/fetch
    branch: develop
  
  3. For a single file:
    url: https://github.com/username/repository
    file: src/components/Button.tsx
  
  4. For directory structure with README files only:
    url: https://github.com/username/repository
    mode: tree
  
  The tool will correctly parse the repository structure and fetch the files from the specified branch.
  `,
        inputSchema: zodToJsonSchema(GithubUrlSchema) as ToolInput,
      },
    ];
  
    return { tools };
  });