js-echo-tool

Generated from plugins/js-echo-tool/README.md.

Example JavaScript/TypeScript tool plugin for the AI Agent Platform.

Plugin id: js_echo_tool
Tool function(s): echo

The tool is authored in TypeScript under src/ and built to dist/index.js.

Build

This repo uses esbuild to compile TypeScript:

esbuild src/index.ts --bundle --platform=node --format=esm --outdir=dist

Configure (local path)

Two equivalent ways to reference the plugin from an application config:

Note: these examples assume you are using the application plugin manager (AgentApplication) and have set plugin_cache_dir plus plugin_policy.base_dir so relative paths resolve.

Verbose form:

{
  "plugins": [
    { "node_tool": { "path": "./plugins/js-echo-tool" } }
  ]
}

String shortcut:

{
  "plugins": [
    "node:./plugins/js-echo-tool"
  ]
}

TypeScript build options

Because dist/ is gitignored, the application plugin manager will install dependencies and run the plugin's build script in its cache automatically.

For safety/hardening, you can disable Node installs/builds globally via plugin_policy (applies to all Node tools):

{
  "plugin_policy": {
    "node_install_deps": false,
    "node_build": false,
    "node_allow_install_scripts": false
  }
}

Alternatively, you can build the plugin directory yourself (and ensure the plugin cache contains the built dist/ output).

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.