@aigne/example-workflow-orchestrator 1.1.0-beta.12

package/.env.local.example

@@ -0,0 +1,5 @@
+# Change the name of this file to .env.local and fill in the following values
+
+DEBUG=aigne:mcp
+
+OPENAI_API_KEY="" # Your OpenAI API key

package/README.md

@@ -0,0 +1,192 @@
+# Workflow Orchestrator Demo
+
+This is a demonstration of using [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework) to build a orchestrator workflow.
+
+```mermaid
+flowchart LR
+
+in(In)
+out(Out)
+orchestrator(Orchestrator)
+synthesizer(Synthesizer)
+finder(Finder)
+writer(Writer)
+proofreader(Proofreader)
+fact_checker(Fact Checker)
+style_enforcer(Style Enforcer)
+
+in ==> orchestrator
+orchestrator -.-> finder -.-> synthesizer
+orchestrator -.-> writer -.-> synthesizer
+orchestrator -.-> proofreader -.-> synthesizer
+orchestrator -.-> fact_checker -.-> synthesizer
+orchestrator -.-> style_enforcer -.-> synthesizer
+synthesizer ==> out
+
+classDef inputOutput fill:#f9f0ed,stroke:#debbae,stroke-width:2px,color:#b35b39,font-weight:bolder;
+classDef processing fill:#F0F4EB,stroke:#C2D7A7,stroke-width:2px,color:#6B8F3C,font-weight:bolder;
+
+class in inputOutput
+class out inputOutput
+class orchestrator processing
+class synthesizer processing
+class finder processing
+class writer processing
+class proofreader processing
+class fact_checker processing
+class style_enforcer processing
+```
+## 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
+- [Pnpm](https://pnpm.io) [Optional] if you want to run the example from source code
+
+## Try without Installation
+
+```bash
+export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # setup your OpenAI API key
+
+npx -y @aigne/example-workflow-orchestrator # run the example
+```
+
+## Installation
+
+### Clone the Repository
+
+```bash
+git clone https://github.com/AIGNE-io/aigne-framework
+```
+
+### Install Dependencies
+
+```bash
+cd aigne-framework/examples/workflow-orchestrator
+
+pnpm install
+```
+
+### Setup Environment Variables
+
+Setup your OpenAI API key in the `.env.local` file:
+
+```bash
+OPENAI_API_KEY="" # setup your OpenAI API key here
+```
+
+### Run the Example
+
+```bash
+pnpm start
+```
+
+## Example
+
+The following example demonstrates how to build a orchestrator workflow:
+
+Here is the generated report for this example: [arcblock-deep-research.md](./generated-report-arcblock.md)
+
+```typescript
+import assert from "node:assert";
+import { OrchestratorAgent } from "@aigne/agent-library";
+import { AIAgent, ChatModelOpenAI, ExecutionEngine, MCPAgent } from "@aigne/core-next";
+
+const { OPENAI_API_KEY } = process.env;
+assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
+
+const model = new ChatModelOpenAI({
+  apiKey: OPENAI_API_KEY,
+});
+
+const puppeteer = await MCPAgent.from({
+  command: "npx",
+  args: ["-y", "@modelcontextprotocol/server-puppeteer"],
+});
+
+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.
+  `,
+  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],
+});
+
+const writer = AIAgent.from({
+  name: "writer",
+  description: "Write to the filesystem",
+  instructions: `You are an agent that can write to the filesystem.
+  You are tasked with taking the user's input, addressing it, and
+  writing the result to disk in the appropriate location.`,
+  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],
+});
+
+const engine = new ExecutionEngine({ model });
+
+const result = await engine.run(
+  `\
+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.`,
+  agent,
+);
+console.log(result);
+// Output:
+// {
+//   text: "Having completed the research and documentation tasks focused on ArcBlock, the final deliverable, a comprehensive report titled \"arcblock.md,\" has been created. ...",
+// }
+```
+
+## License
+
+This project is licensed under the MIT License.

package/index.ts

@@ -0,0 +1,105 @@
+#!/usr/bin/env npx -y bun
+
+import assert from "node:assert";
+import { OrchestratorAgent } from "@aigne/agent-library";
+import {
+  AIAgent,
+  ChatModelOpenAI,
+  ExecutionEngine,
+  MCPAgent,
+  runChatLoopInTerminal,
+} from "@aigne/core-next";
+
+const { OPENAI_API_KEY } = process.env;
+assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
+
+const model = new ChatModelOpenAI({
+  apiKey: OPENAI_API_KEY,
+});
+
+const puppeteer = await MCPAgent.from({
+  command: "npx",
+  args: ["-y", "@modelcontextprotocol/server-puppeteer"],
+});
+
+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.
+  `,
+  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],
+});
+
+const writer = AIAgent.from({
+  name: "writer",
+  description: "Write to the filesystem",
+  instructions: `You are an agent that can write to the filesystem.
+  You are tasked with taking the user's input, addressing it, and
+  writing the result to disk in the appropriate location.`,
+  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],
+});
+
+const engine = new ExecutionEngine({ model });
+
+const userAgent = await engine.run(agent);
+
+await runChatLoopInTerminal(userAgent, {
+  welcome: "Welcome to the Orchestrator Agent!",
+  defaultQuestion: `\
+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.`,
+});
+
+process.exit(0);

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@aigne/example-workflow-orchestrator",
+  "version": "1.1.0-beta.12",
+  "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",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AIGNE-io/aigne-framework"
+  },
+  "bin": "index.ts",
+  "files": [
+    ".env.local.example",
+    "*.ts",
+    "README.md"
+  ],
+  "dependencies": {
+    "zod": "^3.24.2",
+    "@aigne/agent-library": "^1.1.0-beta.12",
+    "@aigne/core-next": "^1.1.0-beta.12"
+  },
+  "scripts": {
+    "start": "npx -y bun run index.ts"
+  }
+}

package/usage.ts

@@ -0,0 +1,98 @@
+import assert from "node:assert";
+import { OrchestratorAgent } from "@aigne/agent-library";
+import { AIAgent, ChatModelOpenAI, ExecutionEngine, MCPAgent } from "@aigne/core-next";
+
+const { OPENAI_API_KEY } = process.env;
+assert(OPENAI_API_KEY, "Please set the OPENAI_API_KEY environment variable");
+
+const model = new ChatModelOpenAI({
+  apiKey: OPENAI_API_KEY,
+});
+
+const puppeteer = await MCPAgent.from({
+  command: "npx",
+  args: ["-y", "@modelcontextprotocol/server-puppeteer"],
+});
+
+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.
+  `,
+  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],
+});
+
+const writer = AIAgent.from({
+  name: "writer",
+  description: "Write to the filesystem",
+  instructions: `You are an agent that can write to the filesystem.
+  You are tasked with taking the user's input, addressing it, and
+  writing the result to disk in the appropriate location.`,
+  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],
+});
+
+const engine = new ExecutionEngine({ model });
+
+const result = await engine.run(
+  `\
+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.`,
+  agent,
+);
+console.log(result);
+// Output:
+// {
+//   text: "Having completed the research and documentation tasks focused on ArcBlock, the final deliverable, a comprehensive report titled \"arcblock.md,\" has been created. ...",
+// }