-
Notifications
You must be signed in to change notification settings - Fork 0
FAQ
GitHub CLI MCP is a server that wraps GitHub CLI commands, making them available to AI assistants through the Model Context Protocol (MCP). It allows AI assistants to interact with GitHub repositories programmatically.
The Model Context Protocol (MCP) is a standardized interface for AI assistants to interact with external tools. It provides a way for AI assistants to call methods on external systems and receive structured responses.
- Node.js v18 or later
- GitHub CLI (installed and authenticated)
You can install GitHub CLI MCP via npm:
npm install -g gh-cli-mcpSee the Installation Guide for more details.
Make sure you have installed the GitHub CLI (gh) and that you've authenticated with GitHub:
# Install GitHub CLI (example for macOS with Homebrew)
brew install gh
# Authenticate with GitHub
gh auth loginFollow the prompts to complete the authentication process.
To update to the latest version:
npm update -g gh-cli-mcpYes, you can use the permissions configuration to specify which tools are allowed or denied. See the Configuration page for details.
You can change the session timeout either through the configuration file or via the command-line option:
gh-cli-mcp --session-timeout 3600000This sets the timeout to 1 hour (3600000 milliseconds).
gh-cli-mcpGitHub CLI MCP can be used with any AI assistant that supports the Model Context Protocol. Configure your assistant to communicate with the GitHub CLI MCP server via stdio.
No, GitHub CLI MCP only supports a single client using stdio transport.
Yes, as long as the GitHub CLI is authenticated with an account that has access to the private repository.
The default timeout for command execution is 30 seconds. If you're working with large repositories or slow network connections, you may need to handle timeouts gracefully in your client application.
You can report bugs or request features by opening an issue on the GitHub repository.
- Make sure Node.js v18 or later is installed
- Verify that GitHub CLI is installed and authenticated
- Check that there are no other instances of GitHub CLI MCP running
- Look for error messages in the console output
- Fork the repository
- Create a feature branch
- Make your changes
- Submit a pull request
Please ensure your code follows the project's coding standards and includes appropriate tests.
GitHub CLI MCP aims to support all features available through the GitHub CLI. If there's a specific feature you'd like to see added, please open an issue on the GitHub repository.
GitHub CLI MCP - Making GitHub CLI accessible to AI assistants via Model Context Protocol