@aigne/example-mcp-github 1.7.2 → 1.9.0

package/LICENSE

@@ -0,0 +1,93 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set of
+the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices
+of the licensor in the software. Any use of the licensor’s trademarks is subject
+to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license for
+the software granted under these terms ends immediately. If your company makes
+such a claim, your patent license ends immediately for work on behalf of your
+company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+## No Liability
+
+*As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim.*
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that
+organization. **control** means ownership of substantially all the assets of an
+entity, or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.

package/README.md

@@ -118,7 +118,7 @@ pnpm example # Run predefined examples
 The following example demonstrates how to use the GitHub MCP server to search for repositories:
 
 ```typescript
-import { AIAgent, ExecutionEngine, MCPAgent } from "@aigne/core";
+import { AIAgent, AIGNE, MCPAgent } from "@aigne/core";
 import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
 
 // Load environment variables
@@ -138,10 +138,10 @@ const githubMCPAgent = await MCPAgent.from({
   },
 });
 
-// Create execution engine
-const engine = new ExecutionEngine({
+// Create AIGNE
+const aigne = new AIGNE({
   model,
-  tools: [githubMCPAgent],
+  skills: [githubMCPAgent],
 });
 
 // Create AI agent with GitHub-specific instructions
@@ -161,7 +161,7 @@ Always provide clear, concise responses with relevant information from GitHub.
 });
 
 // Example: Search for repositories
-const result = await engine.call(
+const result = await aigne.invoke(
   agent,
   "Search for repositories related to 'modelcontextprotocol'"
 );
@@ -174,8 +174,8 @@ console.log(result);
 // 2. **modelcontextprotocol/modelcontextprotocol** - The main ModelContextProtocol repository
 // ...
 
-// Shutdown the engine when done
-await engine.shutdown();
+// Shutdown the aigne when done
+await aigne.shutdown();
 ```
 
 ## Available GitHub Operations

package/index.test.ts

@@ -0,0 +1,11 @@
+import { expect, test } from "bun:test";
+import { runExampleTest } from "@aigne/test-utils/run-example-test.js";
+
+test(
+  "should successfully run the mcp-github",
+  async () => {
+    const { code } = await runExampleTest();
+    expect(code).toBe(0);
+  },
+  { timeout: 600000 },
+);

package/index.ts

@@ -2,7 +2,7 @@
 
 import assert from "node:assert";
 import { runChatLoopInTerminal } from "@aigne/cli/utils/run-chat-loop.js";
-import { AIAgent, ExecutionEngine, MCPAgent } from "@aigne/core";
+import { AIAgent, AIGNE, MCPAgent } from "@aigne/core";
 import { loadModel } from "@aigne/core/loader/index.js";
 import { logger } from "@aigne/core/utils/logger.js";
 
@@ -22,9 +22,9 @@ const github = await MCPAgent.from({
   },
 });
 
-const engine = new ExecutionEngine({
+const aigne = new AIGNE({
   model,
-  tools: [github],
+  skills: [github],
 });
 
 const agent = AIAgent.from({
@@ -43,7 +43,7 @@ Always provide clear, concise responses with relevant information from GitHub.
   memory: true,
 });
 
-const userAgent = engine.call(agent);
+const userAgent = aigne.invoke(agent);
 
 await runChatLoopInTerminal(userAgent, {
   welcome:

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@aigne/example-mcp-github",
-  "version": "1.7.2",
+  "version": "1.9.0",
   "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",
-  "license": "ISC",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AIGNE-io/aigne-framework"
@@ -18,11 +18,15 @@
   "dependencies": {
     "openai": "^4.94.0",
     "zod": "^3.24.2",
-    "@aigne/core": "^1.10.0",
-    "@aigne/cli": "^1.6.0"
+    "@aigne/cli": "^1.8.0",
+    "@aigne/core": "^1.12.0"
+  },
+  "devDependencies": {
+    "@aigne/test-utils": "^0.1.0"
   },
   "scripts": {
     "start": "bun run index.ts",
-    "lint": "tsc --noEmit"
+    "lint": "tsc --noEmit",
+    "test:llm": "bun test"
   }
 }

package/usages.ts

@@ -1,5 +1,5 @@
 import assert from "node:assert";
-import { AIAgent, ExecutionEngine, MCPAgent } from "@aigne/core";
+import { AIAgent, AIGNE, MCPAgent } from "@aigne/core";
 import { OpenAIChatModel } from "@aigne/core/models/openai-chat-model.js";
 
 const { OPENAI_API_KEY, GITHUB_TOKEN } = process.env;
@@ -18,9 +18,9 @@ const githubMCPAgent = await MCPAgent.from({
   },
 });
 
-const engine = new ExecutionEngine({
+const aigne = new AIGNE({
   model,
-  tools: [githubMCPAgent],
+  skills: [githubMCPAgent],
 });
 
 const agent = AIAgent.from({
@@ -40,7 +40,7 @@ Always provide clear, concise responses with relevant information from GitHub.
 
 // Example 1: Search for repositories
 console.log("Example 1: Searching for repositories");
-const searchResult = await engine.call(
+const searchResult = await aigne.invoke(
   agent,
   "Search for repositories related to 'modelcontextprotocol' and limit to 3 results",
 );
@@ -49,7 +49,7 @@ console.log("\n------------------------\n");
 
 // Example 2: Get file contents
 console.log("Example 2: Getting file contents");
-const fileResult = await engine.call(
+const fileResult = await aigne.invoke(
   agent,
   "Get the content of README.md from modelcontextprotocol/servers repository",
 );
@@ -58,10 +58,10 @@ console.log("\n------------------------\n");
 
 // Example 3: List commits
 console.log("Example 3: Listing commits");
-const commitsResult = await engine.call(
+const commitsResult = await aigne.invoke(
   agent,
   "List the latest 3 commits from the modelcontextprotocol/servers repository",
 );
 console.log(commitsResult);
 
-await engine.shutdown();
+await aigne.shutdown();