@aigne/example-mcp-github 1.5.0 → 1.7.1

package/.env.local.example

@@ -4,4 +4,4 @@ DEBUG=aigne:mcp
 
 OPENAI_API_KEY="" # Your OpenAI API key
 
-GITHUB_PERSONAL_ACCESS_TOKEN="" # Your GitHub Personal Access Token
+GITHUB_TOKEN="" # Your GitHub Personal Access Token

package/README.md

@@ -65,15 +65,17 @@ AI ->> User: Here's the README content: ...
 ## Prerequisites
 
 - [Node.js](https://nodejs.org) and npm installed on your machine
-- [OpenAI API key](https://platform.openai.com/api-keys) used to interact with OpenAI API
+- An [OpenAI API key](https://platform.openai.com/api-keys) for interacting with OpenAI's services
 - [GitHub Personal Access Token](https://github.com/settings/tokens) with appropriate permissions
-- [Pnpm](https://pnpm.io) [Optional] if you want to run the example from source code
+- Optional dependencies (if running the example from source code):
+  - [Bun](https://bun.sh) for running unit tests & examples
+  - [Pnpm](https://pnpm.io) for package management
 
-## Try without Installation
+## Quick Start (No Installation Required)
 
 ```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
+export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Set your OpenAI API key
+export GITHUB_TOKEN=YOUR_GITHUB_TOKEN # Set your GitHub token
 
 npx -y @aigne/example-mcp-github # Run the example
 ```
@@ -99,8 +101,8 @@ pnpm install
 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
+OPENAI_API_KEY="" # Set your OpenAI API key here
+GITHUB_TOKEN="" # Set your GitHub Personal Access Token here
 ```
 
 ### Run the Example
@@ -119,9 +121,8 @@ The following example demonstrates how to use the GitHub MCP server to search fo
 import { AIAgent, ExecutionEngine, MCPAgent } from "@aigne/core";
 import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
 
-
 // Load environment variables
-const { OPENAI_API_KEY, GITHUB_PERSONAL_ACCESS_TOKEN } = process.env;
+const { OPENAI_API_KEY, GITHUB_TOKEN } = process.env;
 
 // Initialize OpenAI model
 const model = new OpenAIChatModel({
@@ -133,7 +134,7 @@ const githubMCPAgent = await MCPAgent.from({
   command: "npx",
   args: ["-y", "@modelcontextprotocol/server-github"],
   env: {
-    GITHUB_PERSONAL_ACCESS_TOKEN,
+    GITHUB_TOKEN,
   },
 });
 
@@ -162,7 +163,7 @@ 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'",
+  "Search for repositories related to 'modelcontextprotocol'"
 );
 
 console.log(result);

package/index.ts

@@ -1,29 +1,24 @@
-#!/usr/bin/env npx -y bun
+#!/usr/bin/env bunwrapper
 
 import assert from "node:assert";
 import { runChatLoopInTerminal } from "@aigne/cli/utils/run-chat-loop.js";
 import { AIAgent, ExecutionEngine, MCPAgent } from "@aigne/core";
-import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
+import { loadModel } from "@aigne/core/loader/index.js";
 import { logger } from "@aigne/core/utils/logger.js";
 
-const { OPENAI_API_KEY, GITHUB_PERSONAL_ACCESS_TOKEN } = process.env;
-assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
-assert(
-  GITHUB_PERSONAL_ACCESS_TOKEN,
-  "Please set the GITHUB_PERSONAL_ACCESS_TOKEN environment variable",
-);
+const { GITHUB_TOKEN } = process.env;
+
+assert(GITHUB_TOKEN, "Please set the GITHUB_TOKEN environment variable");
 
 logger.enable(`aigne:mcp,${process.env.DEBUG}`);
 
-const model = new OpenAIChatModel({
-  apiKey: OPENAI_API_KEY,
-});
+const model = await loadModel();
 
 const github = await MCPAgent.from({
   command: "npx",
   args: ["-y", "@modelcontextprotocol/server-github"],
   env: {
-    GITHUB_PERSONAL_ACCESS_TOKEN,
+    GITHUB_TOKEN,
   },
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/example-mcp-github",
-  "version": "1.5.0",
+  "version": "1.7.1",
   "description": "A demonstration of using AIGNE Framework and GitHub MCP Server to interact with GitHub repositories",
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/mcp-github",
@@ -16,13 +16,13 @@
     "README.md"
   ],
   "dependencies": {
-    "openai": "^4.93.0",
+    "openai": "^4.94.0",
     "zod": "^3.24.2",
-    "@aigne/core": "^1.7.0",
-    "@aigne/cli": "^1.2.0"
+    "@aigne/cli": "^1.5.1",
+    "@aigne/core": "^1.10.0"
   },
   "scripts": {
-    "start": "npx -y bun run index.ts",
+    "start": "bun run index.ts",
     "lint": "tsc --noEmit"
   }
 }

package/usages.ts

@@ -2,12 +2,9 @@ import assert from "node:assert";
 import { AIAgent, ExecutionEngine, MCPAgent } from "@aigne/core";
 import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
 
-const { OPENAI_API_KEY, GITHUB_PERSONAL_ACCESS_TOKEN } = process.env;
+const { OPENAI_API_KEY, GITHUB_TOKEN } = process.env;
 assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
-assert(
-  GITHUB_PERSONAL_ACCESS_TOKEN,
-  "Please set the GITHUB_PERSONAL_ACCESS_TOKEN environment variable",
-);
+assert(GITHUB_TOKEN, "Please set the GITHUB_TOKEN environment variable");
 
 const model = new OpenAIChatModel({
   apiKey: OPENAI_API_KEY,
@@ -17,7 +14,7 @@ const githubMCPAgent = await MCPAgent.from({
   command: "npx",
   args: ["-y", "@modelcontextprotocol/server-github"],
   env: {
-    GITHUB_PERSONAL_ACCESS_TOKEN,
+    GITHUB_TOKEN,
   },
 });