|
| 1 | +# External Agents |
| 2 | + |
| 3 | +The TypeAgent repo includes several example [agents](../../packages/agents/). You can also build **your own application agents** **_outside_** the TypeAgent repo by using the [agent-sdk](./README.md). You can package these **_external_** agents as npm packages and surface them in the [TypeAgent Shell](../shell) and [TypeAgent CLI](../cli). |
| 4 | + |
| 5 | +This document describes how you can build your own external application agents. |
| 6 | + |
| 7 | +## Prerequisites |
| 8 | + |
| 9 | +Begin by exploring the following: |
| 10 | + |
| 11 | +- **Agent-Sdk**: Read about the architecture of the [**agent-sdk**](./README.md). |
| 12 | +- **Example Agents**: |
| 13 | + - Review agents under the [agents](../agents) directory. The [List](../agents/list/) agent provides a good example and template for building an agent. |
| 14 | + - The [Echo](../../examples/agentExamples/echo/) agent illustrates the basics of building your own external application agents. |
| 15 | + |
| 16 | +## Steps to build an `Echo` agent: |
| 17 | + |
| 18 | +For the rest of the documentation, we will assume that the external agent is named **echo**. The echo agent performs a single action: echos any input back to the user. |
| 19 | + |
| 20 | +You can see the end result of this tutorial in [Echo](../../examples/agentExamples/echo/) with some modification (NOTE: The only difference is the @typeagent/agent-sdk dependency) |
| 21 | + |
| 22 | +### Step 1: Create and author the `Echo` agent package |
| 23 | + |
| 24 | +Follow the following steps to create the `Echo` agent packages manually. Start by create a directory `echo`. Then populate the directory with the following content: |
| 25 | + |
| 26 | +**package.json** [package.json](../../examples/agentExamples/echo/package.json) : |
| 27 | + |
| 28 | +The `package.json` contains references to **handler** and **manifest** files in the `exports` field. |
| 29 | + |
| 30 | +```json |
| 31 | +{ |
| 32 | + "name": "echo", |
| 33 | + "version": "0.0.1", |
| 34 | + "description": "Echo example for TypeAgent", |
| 35 | + "license": "MIT", |
| 36 | + "author": "Microsoft", |
| 37 | + "type": "module", |
| 38 | + "exports": { |
| 39 | + "./agent/manifest": "./src/echoManifest.json", |
| 40 | + "./agent/handlers": "./dist/echoActionHandler.js" |
| 41 | + }, |
| 42 | + "scripts": { |
| 43 | + "build": "npm run tsc", |
| 44 | + "clean": "rimraf --glob dist *.tsbuildinfo *.done.build.log", |
| 45 | + "tsc": "tsc -b" |
| 46 | + }, |
| 47 | + "keywords": [], |
| 48 | + "dependencies": { |
| 49 | + "@typeagent/agent-sdk": "0.0.1" |
| 50 | + }, |
| 51 | + "devDependencies": { |
| 52 | + "rimraf": "^5.0.5", |
| 53 | + "typescript": "^5.4.2" |
| 54 | + } |
| 55 | +} |
| 56 | +``` |
| 57 | + |
| 58 | +Every application agent requires the following files to be present in the agent's [**source**](../../examples/agentExamples/echo/src/) directory. |
| 59 | + |
| 60 | +- **Agent Manifest File**: The manifest file is used to register the agent with the TypeAgent ecosystem. |
| 61 | +- **Action Schema File**: The action schema file is used to define the actions that the agent can perform. |
| 62 | +- **Agent Action Handler**: Your code that perform's the agent's actions. |
| 63 | + |
| 64 | +**Agent Manifest File** : [`src/echoManifest.json`](../../examples/agentExamples/echo/src/echoManifest.json) |
| 65 | + |
| 66 | +The manifest file contain reference in `schemaFile` to the path to **schema** file (relative path to the **manifest** file) and the `schemaType` corresponds to the union type of all the actions. |
| 67 | + |
| 68 | +```json |
| 69 | +{ |
| 70 | + "emojiChar": "🦜", |
| 71 | + "schema": { |
| 72 | + "description": "A basic echo agent.", |
| 73 | + "schemaFile": "./echoActionSchema.ts", |
| 74 | + "schemaType": "EchoAction" |
| 75 | + } |
| 76 | +} |
| 77 | +``` |
| 78 | + |
| 79 | +**Agent Action Schema File** : [`src/echoActionSchema.ts`](../../examples/agentExamples/echo/src/echoActionSchema.ts) |
| 80 | + |
| 81 | +```ts |
| 82 | +export type EchoAction = GenEchoAction; |
| 83 | + |
| 84 | +// If the user asks to echo a message back, the system will return a GenEchoAction. The text parameter is the message to be echoed back. |
| 85 | +// will contain the text to be echoed back to the user. |
| 86 | +export type GenEchoAction = { |
| 87 | + actionName: "echoGen"; |
| 88 | + parameters: { |
| 89 | + text: string; |
| 90 | + }; |
| 91 | +}; |
| 92 | +``` |
| 93 | + |
| 94 | +**Agent action handler** : [`src/echoActionHandler.ts`](../../examples/agentExamples/echo/src/echoActionHandler.ts) |
| 95 | + |
| 96 | +```ts |
| 97 | +import { ActionContext, AppAgent, TypeAgentAction } from "@typeagent/agent-sdk"; |
| 98 | +import { |
| 99 | + createActionResultFromTextDisplay, |
| 100 | + createActionResultFromError, |
| 101 | +} from "@typeagent/agent-sdk/helpers/action"; |
| 102 | +import { EchoAction } from "./echoActionSchema.js"; |
| 103 | + |
| 104 | +export function instantiate(): AppAgent { |
| 105 | + return { |
| 106 | + initializeAgentContext: initializeEchoContext, |
| 107 | + executeAction: executeEchoAction, |
| 108 | + }; |
| 109 | +} |
| 110 | + |
| 111 | +type EchoActionContext = { |
| 112 | + echoCount: number; |
| 113 | +}; |
| 114 | + |
| 115 | +async function initializeEchoContext(): Promise<EchoActionContext> { |
| 116 | + return { echoCount: 0 }; |
| 117 | +} |
| 118 | + |
| 119 | +async function executeEchoAction( |
| 120 | + action: TypeAgentAction<EchoAction>, |
| 121 | + context: ActionContext<EchoActionContext> |
| 122 | +) { |
| 123 | + // The context created in initializeEchoContext is returned in the action context. |
| 124 | + const echoContext = context.sessionContext.agentContext; |
| 125 | + switch (action.actionName) { |
| 126 | + case "echoGen": |
| 127 | + const displayText = `>> Echo ${++echoContext.echoCount}: ${ |
| 128 | + action.parameters.text |
| 129 | + }`; |
| 130 | + return createActionResultFromTextDisplay(displayText, displayText); |
| 131 | + |
| 132 | + default: |
| 133 | + return createActionResultFromError("Unable to process the action"); |
| 134 | + } |
| 135 | +} |
| 136 | +``` |
| 137 | + |
| 138 | +**Typescript build config file** [`tsconfig.json`](../../examples/agentExamples/echo/tsconfig.json) |
| 139 | + |
| 140 | +```json |
| 141 | +{ |
| 142 | + "compilerOptions": { |
| 143 | + "composite": true, |
| 144 | + "target": "es2021", |
| 145 | + "lib": ["es2021"], |
| 146 | + "module": "node16", |
| 147 | + "declaration": true, |
| 148 | + "declarationMap": true, |
| 149 | + "esModuleInterop": true, |
| 150 | + "exactOptionalPropertyTypes": true, |
| 151 | + "forceConsistentCasingInFileNames": true, |
| 152 | + "incremental": true, |
| 153 | + "noEmitOnError": true, |
| 154 | + "noUnusedLocals": true, |
| 155 | + "skipLibCheck": true, |
| 156 | + "strict": true, |
| 157 | + "sourceMap": true, |
| 158 | + "rootDir": "./src", |
| 159 | + "outDir": "./dist" |
| 160 | + }, |
| 161 | + "include": ["./src/**/*"], |
| 162 | + "ts-node": { |
| 163 | + "esm": true |
| 164 | + } |
| 165 | +} |
| 166 | +``` |
| 167 | + |
| 168 | +#### Folder structure for **Echo** agent: |
| 169 | + |
| 170 | + |
| 171 | + |
| 172 | +<a id="install_agent"></a> |
| 173 | + |
| 174 | +#### Step 2: Build the Agent |
| 175 | + |
| 176 | +First make sure the [TypeAgent's typescript code](../..) is built. |
| 177 | + |
| 178 | +- Go to `<repo>/ts` |
| 179 | +- `pnpm i` |
| 180 | +- `pnpm run build` |
| 181 | + |
| 182 | +Then link the `@typeagent/agent-sdk` package to the `Echo` agent. |
| 183 | + |
| 184 | +- Go to `<repo>/ts/packages/agentSdk` |
| 185 | +- `npm link` |
| 186 | + |
| 187 | +In the `Echo` package, Run the following to build |
| 188 | + |
| 189 | +- `npm link @typeagent/agent-sdk` |
| 190 | +- `npm install` |
| 191 | +- `npm run build` |
| 192 | + |
| 193 | +### Step 3: Install `Echo` agent in TypeAgent cli or shell. |
| 194 | + |
| 195 | +Start TypeAgent [Shell](../shell) or [CLI](../cli) |
| 196 | + |
| 197 | +```bash |
| 198 | +# you can run these commands from the `ts` folder |
| 199 | +# in the TypeAgent root. |
| 200 | + |
| 201 | +pnpm run cli interactive |
| 202 | + |
| 203 | +or |
| 204 | + |
| 205 | +pnpm run shell |
| 206 | +``` |
| 207 | + |
| 208 | +In the [Shell](../shell) or [CLI](../cli), install the echo agent and check the status by issuing the command: |
| 209 | + |
| 210 | +``` |
| 211 | +@install echo <path to echo package> |
| 212 | +@config agent |
| 213 | +``` |
| 214 | + |
| 215 | +The `Echo` agent should be in the list and enabled. |
| 216 | + |
| 217 | +### Step 4: See the `Echo` agent in action |
| 218 | + |
| 219 | +`Echo` agent is now ready. Test it out by issuing some request to see the `Echo` agent in action |
| 220 | + |
| 221 | +When to run the cli this is how interaction with the `Echo` agent will look like: |
| 222 | + |
| 223 | + |
| 224 | +When to run the shell this is how interaction with the `Echo` agent will look like: |
| 225 | + |
| 226 | + |
| 227 | +The `Echo` agent will be reloaded again after installation. It can be uninstalled using the command: |
| 228 | + |
| 229 | +``` |
| 230 | +@uninstall echo |
| 231 | +``` |
| 232 | + |
| 233 | +## Next step |
| 234 | + |
| 235 | +Start modifying the `Echo` agent and add new action schema and action handlers. |
| 236 | + |
| 237 | +## Trademarks |
| 238 | + |
| 239 | +This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft |
| 240 | +trademarks or logos is subject to and must follow |
| 241 | +[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). |
| 242 | +Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. |
| 243 | +Any use of third-party trademarks or logos are subject to those third-party's policies. |
0 commit comments