@aigne/example-workflow-orchestrator 1.3.0 → 1.3.1

package/README.md

@@ -98,48 +98,44 @@ Here is the generated report for this example: [arcblock-deep-research.md](./gen
 ```typescript
 import assert from "node:assert";
 import { OrchestratorAgent } from "@aigne/agent-library";
-import { AIAgent, OpenAIChatModel, ExecutionEngine, MCPAgent } from "@aigne/core";
+import { AIAgent, ExecutionEngine, MCPAgent, OpenAIChatModel } from "@aigne/core";
 
 const { OPENAI_API_KEY } = process.env;
 assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
 
 const model = new OpenAIChatModel({
   apiKey: OPENAI_API_KEY,
+  modelOptions: {
+    parallelToolCalls: false, // puppeteer can only run one task at a time
+  },
 });
 
 const puppeteer = await MCPAgent.from({
   command: "npx",
   args: ["-y", "@modelcontextprotocol/server-puppeteer"],
-  env: {
-    ...(process.env as Record<string, string>),
-  },
+  env: process.env as Record<string, string>,
+});
+
+const filesystem = await MCPAgent.from({
+  command: "npx",
+  args: ["-y", "@modelcontextprotocol/server-filesystem", import.meta.dir],
 });
 
 const finder = AIAgent.from({
   name: "finder",
   description: "Find the closest match to a user's request",
-  instructions: `You are an agent with access to the filesystem,
-  as well as the ability to fetch URLs. Your job is to identify
-  the closest match to a user's request, make the appropriate tool calls,
-  and return the URI and CONTENTS of the closest match.
-
-  Rules:
-  - use document.body.innerText to get the text content of a page
-  - if you want a url to some page, you should get all link and it's title of current(home) page,
-  then you can use the title to search the url of the page you want to visit.
+  instructions: `You are an agent that can find information on the web.
+You are tasked with finding the closest match to the user's request.
+You can use puppeteer to scrape the web for information.
+You can also use the filesystem to save the information you find.
+
+Rules:
+- do not use screenshot of puppeteer
+- use document.body.innerText to get the text content of a page
+- if you want a url to some page, you should get all link and it's title of current(home) page,
+then you can use the title to search the url of the page you want to visit.
   `,
-  tools: [puppeteer],
-});
-
-const enhancedFinder = OrchestratorAgent.from({
-  name: "enhanced_finder",
-  description: "Enhanced finder with more tools",
-  tools: [finder],
-});
-
-const filesystem = await MCPAgent.from({
-  command: "npx",
-  args: ["-y", "@modelcontextprotocol/server-filesystem", import.meta.dir],
+  tools: [puppeteer, filesystem],
 });
 
 const writer = AIAgent.from({
@@ -151,42 +147,18 @@ const writer = AIAgent.from({
   tools: [filesystem],
 });
 
-const proofreader = AIAgent.from({
-  name: "proofreader",
-  description: "Review the short story for grammar, spelling, and punctuation errors",
-  instructions: `Review the short story for grammar, spelling, and punctuation errors.
-  Identify any awkward phrasing or structural issues that could improve clarity.
-  Provide detailed feedback on corrections.`,
-  tools: [],
-});
-
-const fact_checker = AIAgent.from({
-  name: "fact_checker",
-  description: "Verify the factual consistency within the story",
-  instructions: `Verify the factual consistency within the story. Identify any contradictions,
-  logical inconsistencies, or inaccuracies in the plot, character actions, or setting.
-  Highlight potential issues with reasoning or coherence.`,
-  tools: [],
-});
-
-const style_enforcer = AIAgent.from({
-  name: "style_enforcer",
-  description: "Analyze the story for adherence to style guidelines",
-  instructions: `Analyze the story for adherence to style guidelines.
-  Evaluate the narrative flow, clarity of expression, and tone. Suggest improvements to
-  enhance storytelling, readability, and engagement.`,
-  tools: [],
-});
-
 const agent = OrchestratorAgent.from({
-  tools: [enhancedFinder, writer, proofreader, fact_checker, style_enforcer],
+  tools: [finder, writer],
+  maxIterations: 3,
+  tasksConcurrency: 1, // puppeteer can only run one task at a time
 });
 
 const engine = new ExecutionEngine({ model });
 
 const result = await engine.call(
   agent,
-  `Conduct an in-depth research on ArcBlock using only the official website\
+  `\
+Conduct an in-depth research on ArcBlock using only the official website\
 (avoid search engines or third-party sources) and compile a detailed report saved as arcblock.md. \
 The report should include comprehensive insights into the company's products \
 (with detailed research findings and links), technical architecture, and future plans.`,
@@ -194,7 +166,7 @@ The report should include comprehensive insights into the company's products \
 console.log(result);
 // Output:
 // {
-//   $message: "Having completed the research and documentation tasks focused on ArcBlock, the final deliverable, a comprehensive report titled \"arcblock.md,\" has been created. ...",
+//   $message: "The objective of conducting in-depth research on ArcBlock using only the official website has been successfully completed...",
 // }
 ```
 

package/index.ts

@@ -15,6 +15,9 @@ assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
 
 const model = new OpenAIChatModel({
   apiKey: OPENAI_API_KEY,
+  modelOptions: {
+    parallelToolCalls: false, // puppeteer can only run one task at a time
+  },
 });
 
 const puppeteer = await MCPAgent.from({
@@ -23,31 +26,26 @@ const puppeteer = await MCPAgent.from({
   env: process.env as Record<string, string>,
 });
 
+const filesystem = await MCPAgent.from({
+  command: "npx",
+  args: ["-y", "@modelcontextprotocol/server-filesystem", import.meta.dir],
+});
+
 const finder = AIAgent.from({
   name: "finder",
   description: "Find the closest match to a user's request",
-  instructions: `You are an agent with access to the filesystem,
-  as well as the ability to fetch URLs. Your job is to identify
-  the closest match to a user's request, make the appropriate tool calls,
-  and return the URI and CONTENTS of the closest match.
-
-  Rules:
-  - use document.body.innerText to get the text content of a page
-  - if you want a url to some page, you should get all link and it's title of current(home) page,
-  then you can use the title to search the url of the page you want to visit.
+  instructions: `You are an agent that can find information on the web.
+You are tasked with finding the closest match to the user's request.
+You can use puppeteer to scrape the web for information.
+You can also use the filesystem to save the information you find.
+
+Rules:
+- do not use screenshot of puppeteer
+- use document.body.innerText to get the text content of a page
+- if you want a url to some page, you should get all link and it's title of current(home) page,
+then you can use the title to search the url of the page you want to visit.
   `,
-  tools: [puppeteer],
-});
-
-const enhancedFinder = OrchestratorAgent.from({
-  name: "enhanced_finder",
-  description: "Enhanced finder with more tools",
-  tools: [finder],
-});
-
-const filesystem = await MCPAgent.from({
-  command: "npx",
-  args: ["-y", "@modelcontextprotocol/server-filesystem", import.meta.dir],
+  tools: [puppeteer, filesystem],
 });
 
 const writer = AIAgent.from({
@@ -59,35 +57,10 @@ const writer = AIAgent.from({
   tools: [filesystem],
 });
 
-const proofreader = AIAgent.from({
-  name: "proofreader",
-  description: "Review the short story for grammar, spelling, and punctuation errors",
-  instructions: `Review the short story for grammar, spelling, and punctuation errors.
-  Identify any awkward phrasing or structural issues that could improve clarity.
-  Provide detailed feedback on corrections.`,
-  tools: [],
-});
-
-const fact_checker = AIAgent.from({
-  name: "fact_checker",
-  description: "Verify the factual consistency within the story",
-  instructions: `Verify the factual consistency within the story. Identify any contradictions,
-  logical inconsistencies, or inaccuracies in the plot, character actions, or setting.
-  Highlight potential issues with reasoning or coherence.`,
-  tools: [],
-});
-
-const style_enforcer = AIAgent.from({
-  name: "style_enforcer",
-  description: "Analyze the story for adherence to style guidelines",
-  instructions: `Analyze the story for adherence to style guidelines.
-  Evaluate the narrative flow, clarity of expression, and tone. Suggest improvements to
-  enhance storytelling, readability, and engagement.`,
-  tools: [],
-});
-
 const agent = OrchestratorAgent.from({
-  tools: [enhancedFinder, writer, proofreader, fact_checker, style_enforcer],
+  tools: [finder, writer],
+  maxIterations: 3,
+  tasksConcurrency: 1, // puppeteer can only run one task at a time
 });
 
 const engine = new ExecutionEngine({ model });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/example-workflow-orchestrator",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "A demonstration of using AIGNE Framework to build a orchestrator workflow",
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/workflow-orchestrator",
@@ -18,8 +18,8 @@
   "dependencies": {
     "openai": "^4.89.0",
     "zod": "^3.24.2",
-    "@aigne/agent-library": "^1.3.0",
-    "@aigne/core": "^1.3.0"
+    "@aigne/agent-library": "^1.3.1",
+    "@aigne/core": "^1.4.0"
   },
   "scripts": {
     "start": "npx -y bun run index.ts",

package/usage.ts

@@ -7,41 +7,37 @@ assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
 
 const model = new OpenAIChatModel({
   apiKey: OPENAI_API_KEY,
+  modelOptions: {
+    parallelToolCalls: false, // puppeteer can only run one task at a time
+  },
 });
 
 const puppeteer = await MCPAgent.from({
   command: "npx",
   args: ["-y", "@modelcontextprotocol/server-puppeteer"],
-  env: {
-    ...(process.env as Record<string, string>),
-  },
+  env: process.env as Record<string, string>,
+});
+
+const filesystem = await MCPAgent.from({
+  command: "npx",
+  args: ["-y", "@modelcontextprotocol/server-filesystem", import.meta.dir],
 });
 
 const finder = AIAgent.from({
   name: "finder",
   description: "Find the closest match to a user's request",
-  instructions: `You are an agent with access to the filesystem,
-  as well as the ability to fetch URLs. Your job is to identify
-  the closest match to a user's request, make the appropriate tool calls,
-  and return the URI and CONTENTS of the closest match.
+  instructions: `You are an agent that can find information on the web.
+You are tasked with finding the closest match to the user's request.
+You can use puppeteer to scrape the web for information.
+You can also use the filesystem to save the information you find.
 
-  Rules:
-  - use document.body.innerText to get the text content of a page
-  - if you want a url to some page, you should get all link and it's title of current(home) page,
-  then you can use the title to search the url of the page you want to visit.
+Rules:
+- do not use screenshot of puppeteer
+- use document.body.innerText to get the text content of a page
+- if you want a url to some page, you should get all link and it's title of current(home) page,
+then you can use the title to search the url of the page you want to visit.
   `,
-  tools: [puppeteer],
-});
-
-const enhancedFinder = OrchestratorAgent.from({
-  name: "enhanced_finder",
-  description: "Enhanced finder with more tools",
-  tools: [finder],
-});
-
-const filesystem = await MCPAgent.from({
-  command: "npx",
-  args: ["-y", "@modelcontextprotocol/server-filesystem", import.meta.dir],
+  tools: [puppeteer, filesystem],
 });
 
 const writer = AIAgent.from({
@@ -53,42 +49,18 @@ const writer = AIAgent.from({
   tools: [filesystem],
 });
 
-const proofreader = AIAgent.from({
-  name: "proofreader",
-  description: "Review the short story for grammar, spelling, and punctuation errors",
-  instructions: `Review the short story for grammar, spelling, and punctuation errors.
-  Identify any awkward phrasing or structural issues that could improve clarity.
-  Provide detailed feedback on corrections.`,
-  tools: [],
-});
-
-const fact_checker = AIAgent.from({
-  name: "fact_checker",
-  description: "Verify the factual consistency within the story",
-  instructions: `Verify the factual consistency within the story. Identify any contradictions,
-  logical inconsistencies, or inaccuracies in the plot, character actions, or setting.
-  Highlight potential issues with reasoning or coherence.`,
-  tools: [],
-});
-
-const style_enforcer = AIAgent.from({
-  name: "style_enforcer",
-  description: "Analyze the story for adherence to style guidelines",
-  instructions: `Analyze the story for adherence to style guidelines.
-  Evaluate the narrative flow, clarity of expression, and tone. Suggest improvements to
-  enhance storytelling, readability, and engagement.`,
-  tools: [],
-});
-
 const agent = OrchestratorAgent.from({
-  tools: [enhancedFinder, writer, proofreader, fact_checker, style_enforcer],
+  tools: [finder, writer],
+  maxIterations: 3,
+  tasksConcurrency: 1, // puppeteer can only run one task at a time
 });
 
 const engine = new ExecutionEngine({ model });
 
 const result = await engine.call(
   agent,
-  `Conduct an in-depth research on ArcBlock using only the official website\
+  `\
+Conduct an in-depth research on ArcBlock using only the official website\
 (avoid search engines or third-party sources) and compile a detailed report saved as arcblock.md. \
 The report should include comprehensive insights into the company's products \
 (with detailed research findings and links), technical architecture, and future plans.`,
@@ -96,5 +68,5 @@ The report should include comprehensive insights into the company's products \
 console.log(result);
 // Output:
 // {
-//   $message: "Having completed the research and documentation tasks focused on ArcBlock, the final deliverable, a comprehensive report titled \"arcblock.md,\" has been created. ...",
+//   $message: "The objective of conducting in-depth research on ArcBlock using only the official website has been successfully completed...",
 // }