@aigne/example-mcp-github 1.17.4 → 1.17.5-beta.1

package/README.md

@@ -81,52 +81,70 @@ AI ->> User: Here's the README content: ...
 
 ## Quick Start (No Installation Required)
 
+### Run the Example
+
 ```bash
-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
 ```
 
-## Installation
+### Connect to an AI Model
 
-### Clone the Repository
+As an example, running `npx -y @aigne/example-mcp-github` requires an AI model. If this is your first run, you need to connect one.
+
+![run example](./run-example.png)
+
+- Connect via the official AIGNE Hub
+
+Choose the first option and your browser will open the official AIGNE Hub page. Follow the prompts to complete the connection. If you're a new user, the system automatically grants 400,000 tokens for you to use.
+
+![connect to official aigne hub](../images/connect-to-aigne-hub.png)
+
+- Connect via a self-hosted AIGNE Hub
+
+Choose the second option, enter the URL of your self-hosted AIGNE Hub, and follow the prompts to complete the connection. If you need to set up a self-hosted AIGNE Hub, visit the Blocklet Store to install and deploy it: [Blocklet Store](https://store.blocklet.dev/blocklets/z8ia3xzq2tMq8CRHfaXj1BTYJyYnEcHbqP8cJ?utm_source=www.arcblock.io&utm_medium=blog_link&utm_campaign=default&utm_content=store.blocklet.dev#:~:text=%F0%9F%9A%80%20Get%20Started%20in%20Minutes).
+
+![connect to self hosted aigne hub](../images/connect-to-self-hosted-aigne-hub.png)
+
+- Connect via a third-party model provider
+
+Using OpenAI as an example, you can configure the provider's API key via environment variables. After configuration, run the example again:
 
 ```bash
-git clone https://github.com/AIGNE-io/aigne-framework
+export OPENAI_API_KEY="" # Set your OpenAI API key here
 ```
+For more details on third-party model configuration (e.g., OpenAI, DeepSeek, Google Gemini), see [.env.local.example](./.env.local.example).
 
-### Install Dependencies
+After configuration, run the example again.
 
-```bash
-cd aigne-framework/examples/mcp-github
+### Debugging
 
-pnpm install
-```
+The `aigne observe` command starts a local web server to monitor and analyze agent execution data. It provides a user-friendly interface to inspect traces, view detailed call information, and understand your agent’s behavior during runtime. This tool is essential for debugging, performance tuning, and gaining insight into how your agent processes information and interacts with tools and models.
+
+Start the observation server.
 
-### Setup Environment Variables
+![aigne-observe-execute](../images/aigne-observe-execute.png)
+
+View a list of recent executions.
+
+![aigne-observe-list](../images/aigne-observe-list.png)
+
+## Installation
 
-Setup your API keys in the `.env.local` file:
+### Clone the Repository
 
 ```bash
-OPENAI_API_KEY="" # Set your OpenAI API key here
-GITHUB_TOKEN="" # Set your GitHub Personal Access Token here
+git clone https://github.com/AIGNE-io/aigne-framework
 ```
 
-#### Using Different Models
-
-You can use different AI models by setting the `MODEL` environment variable along with the corresponding API key. The framework supports multiple providers:
+### Install Dependencies
 
-* **OpenAI**: `MODEL="openai:gpt-4.1"` with `OPENAI_API_KEY`
-* **Anthropic**: `MODEL="anthropic:claude-3-7-sonnet-latest"` with `ANTHROPIC_API_KEY`
-* **Google Gemini**: `MODEL="gemini:gemini-2.0-flash"` with `GEMINI_API_KEY`
-* **AWS Bedrock**: `MODEL="bedrock:us.amazon.nova-premier-v1:0"` with AWS credentials
-* **DeepSeek**: `MODEL="deepseek:deepseek-chat"` with `DEEPSEEK_API_KEY`
-* **OpenRouter**: `MODEL="openrouter:openai/gpt-4o"` with `OPEN_ROUTER_API_KEY`
-* **xAI**: `MODEL="xai:grok-2-latest"` with `XAI_API_KEY`
-* **Ollama**: `MODEL="ollama:llama3.2"` with `OLLAMA_DEFAULT_BASE_URL`
+```bash
+cd aigne-framework/examples/mcp-github
 
-For detailed configuration examples, please refer to the `.env.local.example` file in this directory.
+pnpm install
+```
 
 ### Run the Example
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/example-mcp-github",
-  "version": "1.17.4",
+  "version": "1.17.5-beta.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,15 +16,15 @@
     "README.md"
   ],
   "dependencies": {
-    "@aigne/agent-library": "^1.22.4",
-    "@aigne/cli": "^1.57.3",
-    "@aigne/core": "^1.70.1",
-    "@aigne/default-memory": "^1.3.4",
-    "@aigne/openai": "^0.16.14"
+    "@aigne/core": "^1.71.0-beta.1",
+    "@aigne/cli": "^1.58.0-beta.1",
+    "@aigne/agent-library": "^1.23.0-beta.1",
+    "@aigne/default-memory": "^1.3.5-beta.1",
+    "@aigne/openai": "^0.16.15-beta.1"
   },
   "devDependencies": {
     "@types/bun": "^1.2.22",
-    "@aigne/test-utils": "^0.5.67"
+    "@aigne/test-utils": "^0.5.68-beta.1"
   },
   "scripts": {
     "start": "bun run index.ts",