get_file_contents
Retrieve file or directory contents from GitHub repositories by specifying owner, repo, and path parameters.
Instructions
Get the contents of a file or directory from a GitHub repository
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| owner | Yes | Repository owner (username or organization) | |
| repo | Yes | Repository name | |
| path | Yes | Path to the file or directory | |
| branch | No | Branch to get contents from |
Implementation Reference
- operations/files.ts:87-107 (handler)Core handler function that fetches file or directory contents from GitHub API, decodes base64 content for files, and returns the data.
export async function getFileContents( owner: string, repo: string, path: string, branch?: string ) { let url = `https://api.github.com/repos/${owner}/${repo}/contents/${path}`; if (branch) { url += `?ref=${branch}`; } const response = await githubRequest(url); const data = GitHubContentSchema.parse(response); // If it's a file, decode the content if (!Array.isArray(data) && data.content) { data.content = Buffer.from(data.content, "base64").toString("utf8"); } return data; } - operations/files.ts:34-39 (schema)Zod schema defining the input parameters for the get_file_contents tool.
export const GetFileContentsSchema = z.object({ owner: z.string().describe("Repository owner (username or organization)"), repo: z.string().describe("Repository name"), path: z.string().describe("Path to the file or directory"), branch: z.string().optional().describe("Branch to get contents from"), }); - index.ts:83-87 (registration)Registration of the get_file_contents tool in the MCP server's listTools response, including name, description, and input schema.
{ name: "get_file_contents", description: "Get the contents of a file or directory from a GitHub repository", inputSchema: zodToJsonSchema(files.GetFileContentsSchema), }, - index.ts:210-221 (handler)MCP tool call handler that validates input arguments using the schema and delegates to the getFileContents implementation, returning JSON stringified response.
case "get_file_contents": { const args = files.GetFileContentsSchema.parse(request.params.arguments); const contents = await files.getFileContents( args.owner, args.repo, args.path, args.branch ); return { content: [{ type: "text", text: JSON.stringify(contents, null, 2) }], }; }