GitHub Pages MCP Server
About
Hello! This is a GitHub MCP server designed to enable MCP-compatible LLMs, such as Claude, to communicate with the server and interact with the GitHub API to manage GitHub Pages deployments.
Details
- Author
- ajaychinthapalli
- Categories
- Developer Tools, Other, Infrastructure
Jump to
Setup
Install GitHub Pages MCP Server in your MCP client (Claude Desktop, Cursor, Windsurf, and others).
Repository: https://github.com/ajaychinthapalli/github-pages-mcp-server
Follow the installation instructions in the repository README, then restart your MCP client.
Hello! This is a GitHub MCP server designed to enable MCP-compatible LLMs, such as Claude, to communicate with the server and interact with the GitHub API to manage GitHub Pages deployments.
A Model Context Protocol (MCP) server for managing GitHub Pages deployments. This server provides tools to enable, configure, deploy, and manage GitHub Pages sites through the MCP protocol.
This MCP server provides the following tools:
- enable_github_pages- Enable GitHub Pages for a repository with custom source and build settings
- get_github_pages_info- Get current GitHub Pages configuration and deployment status
- deploy_to_github_pages- Deploy files directly to GitHub Pages branch
- disable_github_pages- Disable GitHub Pages for a repository
- update_github_pages_config- Update GitHub Pages configuration (source, build type, custom domain)
The server requires a GitHub Personal Access Token with appropriate permissions to manage GitHub Pages.
Your GitHub token needs the following scopes:
- repo(Full control of private repositories)
- public_repo(Access public repositories)
- workflow(Update GitHub Action workflows, if using workflow build type)
Set theGITHUB_TOKENenvironment variable:
# Build and run npm run build node dist/index.js
Add to your MCP client configuration (e.g., Claude Desktop config):
{ "mcpServers": { "github-pages": { "command": "node", "args": ["/path/to/github-pages-mcp-server/dist/index.js"], "env": { "GITHUB_TOKEN": "your_github_token_here" } } } }
- owner(string, required): Repository owner (username or organization)
- repo(string, required): Repository name
- source(object, required):
- branch(string, required): Branch to deploy from (e.g., 'main', 'gh-pages')
- path(string, optional): Path to deploy from ('/' or '/docs')
{ "owner": "username", "repo": "my-website", "source": { "branch": "main", "path": "/docs" }, "build_type": "legacy" }
Get the current GitHub Pages configuration and status.
- owner(string, required): Repository owner
- repo(string, required): Repository name
{ "owner": "username", "repo": "my-website" }
Deploy files to a GitHub Pages branch by creating commits.
- owner(string, required): Repository owner
- repo(string, required): Repository name
- branch(string, required): Branch to deploy to (must match GitHub Pages source branch)
- message(string, optional): Commit message
- files(array, optional): Array of files to deploy
- path(string, required): File path in repository
- content(string, required): File content
- encoding(string, optional): 'utf-8' or 'base64'
{ "owner": "username", "repo": "my-website", "branch": "gh-pages", "message": "Update homepage", "files": [ { "path": "index.html", "content": "<html><body>Hello World</body></html>", "encoding": "utf-8" } ] }
- owner(string, required): Repository owner
- repo(string, required): Repository name
{ "owner": "username", "repo": "my-website" }
Update GitHub Pages configuration settings.
- owner(string, required): Repository owner
- repo(string, required): Repository name
- source(object, optional):
- branch(string, required): Branch to deploy from
- path(string, optional): Path to deploy from
{ "owner": "username", "repo": "my-website", "source": { "branch": "main", "path": "/" }, "cname": "www.example.com" }
This project uses GitHub Actions to automatically create releases when version tags are pushed.
- Update the version inpackage.json
- Commit the changes
- Create and push a version tag:
The GitHub Actions workflow will automatically:
- Build the project
- Create a GitHub release with the tag
- Upload release assets:
- github-pages-mcp-server-dist.tar.gz- Compiled distribution files
- github-pages-mcp-server-full.tar.gz- Full source code (excluding node_modules)
- Node.js >= 18.0.0
- GitHub Personal Access Token with repo permissions
Interact with GitHub APIs for automation and repository management.
Integrate with the GitHub Enterprise API to access repositories, issues, pull requests, and workflows.
Integrates with GitHub APIs for advanced automation and interaction, supporting both remote and local deployments.
Integrate with GitHub APIs for automation and interaction.
Seamlessly integrate with GitHub APIs for development automation and interaction.
Seamlessly integrate with GitHub APIs for development automation and interaction.
Query GitHub Enterprise license data, including summaries, per-user details, organization memberships, and enterprise roles.
Bult.ai MCP Server lets Claude Desktop deploy and manage Bult.ai cloud hosting resources, including projects, services, GitHub and Docker deployments, routes, volumes, templates, logs, and build history.
Official GitHub MCP server for repository search, issues, pull requests, code context, and GitHub workflows in MCP-compatible AI clients.
A CLI for interacting with GitKraken APIs. Includes an MCP server via gk mcp that not only wraps GitKraken APIs, but also Jira, GitHub, GitLab, and more.
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
