> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub MCP Integration

> Guide for integrating GitHub repository management with PraisonAI agents using MCP

## Add GitHub Tool to AI Agent

```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
flowchart LR
    In[Query] --> Agent[AI Agent]
    Agent --> Tool[GitHub MCP]
    Tool --> Agent
    Agent --> Out[Answer]
    
    style In fill:#8B0000,color:#fff
    style Agent fill:#2E8B57,color:#fff
    style Tool fill:#181717,color:#fff
    style Out fill:#8B0000,color:#fff
```

## Quick Start

<Steps>
  <Step title="Install Dependencies">
    Make sure you have Node.js installed, as the MCP server requires it:

    ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    pip install praisonaiagents mcp
    ```
  </Step>

  <Step title="Set API Key">
    Set your GitHub Personal Access Token as an environment variable in your terminal:

    ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    export GITHUB_PERSONAL_ACCESS_TOKEN=your_github_token_here
    export OPENAI_API_KEY=your_openai_api_key_here
    ```
  </Step>

  <Step title="Create a file">
    Create a new file `github_agent.py` with the following code:

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    from praisonaiagents import Agent, MCP
    import os

    # Use the API key from environment or set it directly
    github_token = os.getenv("GITHUB_PERSONAL_ACCESS_TOKEN")

    # Use a single string command with environment variables
    github_agent = Agent(
        instructions="""You are a helpful assistant that can interact with GitHub.
        Use the available tools when relevant to answer user questions.""",
        llm="gpt-4o-mini",
        tools=MCP("npx -y @modelcontextprotocol/server-github", 
                env={"GITHUB_PERSONAL_ACCESS_TOKEN": github_token})
    )

    github_agent.start("List my GitHub repositories")
    ```
  </Step>

  <Step title="Run the Agent">
    Execute your script:

    ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    python github_agent.py
    ```
  </Step>
</Steps>

<Note>
  **Requirements**

  * Python 3.10 or higher
  * Node.js installed on your system
  * GitHub Personal Access Token
  * OpenAI API key (for the agent's LLM)
</Note>
