How do I install the github pages mcp server?

Use a recorded configuration for your client, replace example credential values and paths, and verify the documented runtime. Restart or reconnect the client, then inspect the available tools.

What credentials does it need?

It reads `GITHUB_TOKEN` from the environment. Store these in your client's env block or a secrets manager — never commit them to a repository — and grant the narrowest scope that still covers your use case.

SSyncDev

Start a project

Github Pages MCP Server

MCP server for managing GitHub Pages deployments

Local serverstdio

What is the Github Pages MCP Server?

MCP server for managing GitHub Pages deployments

What the server does

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.

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)

Credentials and setup notes

Node.js >= 18.0.0 - GitHub Personal Access Token with repo permissions

More MCP options

Compare MCP servers by category, or browse hosted MCP servers if you prefer an endpoint over a local process.

Maintainer setup documentation.

Recorded tools

Check the linked publisher documentation and your connected client's tool list. Names and availability can vary with the server version and account permissions.

Tool	What it does
enable_github_pages
get_github_pages_info
deploy_to_github_pages
disable_github_pages
update_github_pages_config

How to install the Github Pages MCP Server

{
  "mcpServers": {
    "github-pages": {
      "command": "node",
      "args": [
        "/path/to/github-pages-mcp-server/dist/index.js"
      ],
      "env": {
        "GITHUB_TOKEN": "YOUR_GITHUB_TOKEN"
      }
    }
  }
}

From the project documentation. Replace placeholders and example paths before connecting.

Configuration

Node.js >= 18.0.0 - GitHub Personal Access Token with repo permissions

Variable	Description	Required
GITHUB_TOKEN	Declared in the maintainer’s client configuration.	Check documentation

Example prompts to try

“Use Github Pages to enable github pages.”
“Use Github Pages to get github pages info.”
“Use Github Pages to deploy to github pages.”

Frequently asked questions

MCP server for managing GitHub Pages deployments Confirm the tools offered by your installed version in the connected client. Tool availability and permissions depend on the server and account configuration.