GitHub MCP Server Integration

This is a demonstration of using AIGNE Framework and GitHub MCP Server to interact with GitHub repositories.

``mermaid
flowchart LR

in(In)
out(Out)
agent(AI Agent)
github(GitHub MCP Agent)
searchRepos(Search Repositories)
getContents(Get Contents)
createFile(Create/Update File)
issue(Issues & PRs)

in --> agent <--> github

subgraph MCP Agent
github <--> searchRepos
github <--> getContents
github <--> createFile
github <--> issue
end

agent --> out

classDef inputOutput fill:#f9f0ed,stroke:#debbae,stroke-width:2px,color:#b35b39,font-weight:bolder;
classDef processing fill:#F0F4EB,stroke:#C2D7A7,stroke-width:2px,color:#6B8F3C,font-weight:bolder;

class in inputOutput
class out inputOutput
class agent processing
class github processing
class searchRepos processing
class getContents processing
class createFile processing
class issue processing
`

Following is a sequence diagram of the workflow to search for repositories and access contents:

`mermaid
sequenceDiagram
participant User
participant AI as AI Agent
participant G as GitHub MCP Agent
participant SR as Search Repositories
participant GC as Get Contents

User ->> AI: Search for repositories related to 'modelcontextprotocol'
AI ->> G: Use search_repositories function
G ->> SR: Execute search with query='modelcontextprotocol'
SR ->> G: Return repository list results
G ->> AI: Formatted repository information
AI ->> User: Found these repositories: modelcontextprotocol/servers, etc.
User ->> AI: Get README from the servers repo
AI ->> G: Use get_file_contents function
G ->> GC: Access README.md in modelcontextprotocol/servers
GC ->> G: Return file content
G ->> AI: Formatted file content
AI ->> User: Here's the README content: ...
`

Prerequisites

- Node.js and npm installed on your machine
- OpenAI API key used to interact with OpenAI API
- GitHub Personal Access Token with appropriate permissions
- Pnpm [Optional] if you want to run the example from source code

Try without Installation

`bash
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Setup your OpenAI API key
export GITHUB_PERSONAL_ACCESS_TOKEN=YOUR_GITHUB_TOKEN # Setup your GitHub token

npx -y @aigne/example-mcp-server-github # Run the example
`

Installation

$3

`bash
git clone https://github.com/AIGNE-io/aigne-framework
`

$3

`bash
cd aigne-framework/examples/mcp-server-github-integrator

pnpm install
`

$3

Setup your API keys in the .env.local file:

`bash
OPENAI_API_KEY="" # Your OpenAI API key
GITHUB_PERSONAL_ACCESS_TOKEN="" # Your GitHub Personal Access Token
`

$3

`bash
pnpm start # Interactive chat interface


or


pnpm example # Run predefined examples
`

Example

The following example demonstrates how to use the GitHub MCP server to search for repositories:

`typescript
import {
AIAgent,
OpenAIChatModel,
ExecutionEngine,
MCPAgent,
} from "@aigne/core";

// Load environment variables
const { OPENAI_API_KEY, GITHUB_PERSONAL_ACCESS_TOKEN } = process.env;

// Initialize OpenAI model
const model = new OpenAIChatModel({
apiKey: OPENAI_API_KEY,
});

// Initialize GitHub MCP agent
const githubMCPAgent = await MCPAgent.from({
command: "npx",
args: ["-y", "@modelcontextprotocol/server-github"],
env: {
GITHUB_PERSONAL_ACCESS_TOKEN,
},
});

// Create execution engine
const engine = new ExecutionEngine({
model,
tools: [githubMCPAgent],
});

// Create AI agent with GitHub-specific instructions
const agent = AIAgent.from({
instructions: \

GitHub Interaction Assistant

You are an assistant that helps users interact with GitHub repositories.
You can perform various GitHub operations like:
1. Searching repositories
2. Getting file contents
3. Creating or updating files
4. Creating issues and pull requests
5. And many more GitHub operations

Always provide clear, concise responses with relevant information from GitHub.
,
});

// Example: Search for repositories
const result = await engine.call(
agent,
"Search for repositories related to 'modelcontextprotocol'",
);

console.log(result.text);
// Output:
// I found several repositories related to 'modelcontextprotocol':
//
// 1. modelcontextprotocol/servers - MCP servers for various APIs and services
// 2. modelcontextprotocol/modelcontextprotocol - The main ModelContextProtocol repository
// ...

// Shutdown the engine when done
await engine.shutdown();
``

Available GitHub Operations

The GitHub MCP server provides a wide range of operations including:

1. Repository Operations:

- Search repositories
- Create repositories
- Get repository information

2. File Operations:

- Get file contents
- Create or update files
- Push multiple files in a single commit

3. Issue and PR Operations:

- Create issues
- Create pull requests
- Add comments
- Merge pull requests

4. Search Operations:

- Search code
- Search issues
- Search users

5. Commit Operations:
- List commits
- Get commit details

License

This project is licensed under the MIT License.