@aigne/example-mcp-github 1.6.0 → 1.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -8
- package/index.ts +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -65,16 +65,17 @@ AI ->> User: Here's the README content: ...
|
|
|
65
65
|
## Prerequisites
|
|
66
66
|
|
|
67
67
|
- [Node.js](https://nodejs.org) and npm installed on your machine
|
|
68
|
-
- [
|
|
69
|
-
- [OpenAI API key](https://platform.openai.com/api-keys) used to interact with OpenAI API
|
|
68
|
+
- An [OpenAI API key](https://platform.openai.com/api-keys) for interacting with OpenAI's services
|
|
70
69
|
- [GitHub Personal Access Token](https://github.com/settings/tokens) with appropriate permissions
|
|
71
|
-
-
|
|
70
|
+
- Optional dependencies (if running the example from source code):
|
|
71
|
+
- [Bun](https://bun.sh) for running unit tests & examples
|
|
72
|
+
- [Pnpm](https://pnpm.io) for package management
|
|
72
73
|
|
|
73
|
-
##
|
|
74
|
+
## Quick Start (No Installation Required)
|
|
74
75
|
|
|
75
76
|
```bash
|
|
76
|
-
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY #
|
|
77
|
-
export GITHUB_TOKEN=YOUR_GITHUB_TOKEN #
|
|
77
|
+
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Set your OpenAI API key
|
|
78
|
+
export GITHUB_TOKEN=YOUR_GITHUB_TOKEN # Set your GitHub token
|
|
78
79
|
|
|
79
80
|
npx -y @aigne/example-mcp-github # Run the example
|
|
80
81
|
```
|
|
@@ -100,8 +101,8 @@ pnpm install
|
|
|
100
101
|
Setup your API keys in the `.env.local` file:
|
|
101
102
|
|
|
102
103
|
```bash
|
|
103
|
-
OPENAI_API_KEY="" #
|
|
104
|
-
GITHUB_TOKEN="" #
|
|
104
|
+
OPENAI_API_KEY="" # Set your OpenAI API key here
|
|
105
|
+
GITHUB_TOKEN="" # Set your GitHub Personal Access Token here
|
|
105
106
|
```
|
|
106
107
|
|
|
107
108
|
### Run the Example
|
package/index.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aigne/example-mcp-github",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.7.1",
|
|
4
4
|
"description": "A demonstration of using AIGNE Framework and GitHub MCP Server to interact with GitHub repositories",
|
|
5
5
|
"author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
|
|
6
6
|
"homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/mcp-github",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"openai": "^4.94.0",
|
|
20
20
|
"zod": "^3.24.2",
|
|
21
|
-
"@aigne/cli": "^1.
|
|
22
|
-
"@aigne/core": "^1.
|
|
21
|
+
"@aigne/cli": "^1.5.1",
|
|
22
|
+
"@aigne/core": "^1.10.0"
|
|
23
23
|
},
|
|
24
24
|
"scripts": {
|
|
25
25
|
"start": "bun run index.ts",
|