@easynet/agent-tool-hub 1.0.10 → 1.0.11

package/README.md

@@ -6,9 +6,82 @@ Define tools with simple, familiar formats: drop a folder under a configured roo
 
 ---
 
+## What we support
+
+| Supported tools | How to write | Spec |
+|-----------------|--------------|------|
+| **SKILL** | We fully support the SKILL spec with any LLM.<br>[Examples](examples/tools/yahoo-finance/skill/)<br>[SKILL spec and our implementation support](docs/AGENT_SKILLS_SPEC.md) | [Agent Skills](https://agentskills.io/specification) |
+| **LangChain** | Export a `StructuredTool` in `langchain/`; we auto-discover.<br>[Examples](examples/tools/filesystem/langchain/) | [LangChain Tools](https://js.langchain.com/docs/modules/agents/tools/) |
+| **MCP** | Put `mcp.json` (Cursor-style) in `mcp/`; we connect as client.<br>We recommend [easy-mcp-server](https://www.npmjs.com/package/easy-mcp-server) for writing MCP servers.<br>[Example](examples/tools/web-search/mcp/) | [MCP Specification](https://modelcontextprotocol.io/specification/latest) |
+| **n8n** | Put workflow JSON in `n8n/`; we run local n8n.<br>[@easynet/n8n-local](https://www.npmjs.com/package/@easynet/n8n-local) | [n8n Workflows](https://docs.n8n.io/workflows/) |
+
+---
+
+## Install
+
+```bash
+npm install @easynet/agent-tool-hub
+```
+
+Node 18+ required.
+
+---
+
+## Run the stock research example
+
+End-to-end demo: **ReAct agent** + **yahoo-finance SKILL tools** + **HTML report**. After [installing](#install), run (examples are bundled; no clone needed):
+
+```bash
+npx agent-toolhub-react-stock GOOGL
+```
+
+Pass the ticker symbol (e.g. `GOOGL`, `AAPL`, `MSFT`). **Configure your own LLM** — point the example to your OpenAI-compatible API (base URL and API key) in [examples/agent-toolhub-react-stock.mjs](examples/agent-toolhub-react-stock.mjs) or via env (e.g. `OPENAI_API_KEY`, `OPENAI_BASE_URL`). The bundled example uses placeholder values; replace them with your model endpoint.
+
+Output: console step-by-step progress + an HTML report (e.g. `GOOGL-research-report.html`) in the current directory. See a sample report: [examples/reports/AAPL-research-report.html](examples/reports/AAPL-research-report.html).
+
+**Agent Run Report** — The generated HTML report is a highlight: it shows system/user prompts, the rendered Markdown report, and a Debug tab with step-by-step execution and token usage.
+
+| Report | Debug |
+|--------|-------|
+| [![Report tab](examples/report-1.png)](examples/report-1.png) | [![Debug tab](examples/report-2.png)](examples/report-2.png) |
+
+---
+
+## Use
+
+### Embed in LangChain (minimal)
+
+Initialize the runtime, then pass the tools to your agent:
+
+```ts
+import { createAgentToolHub } from "@easynet/agent-tool-hub/langchain-tools";
+
+// 1. Init runtime (loads tools from toolhub.yaml)
+const toolHub = await createAgentToolHub("toolhub.yaml");
+
+// 2. Create your LangChain agent, pass our tools, and run
+const agent = createAgent({
+  model: new ChatOpenAI({ temperature: 0 }),
+  tools: toolHub.tools, // discovered tools from SKILL / LangChain / MCP / n8n
+});
+const stream = await agent.stream(/* your messages */);
+// ...
+
+// 3. Shutdown
+await toolHub.shutdown();
+```
+
+**Tracking & reports** — Optional: `formatStepProgress(step)` for console; `writeReportFromStream(stream, { htmlReportPath, onStep })` for an HTML report.
+
+---
+
+## Code reference
+
+Full examples for each tool type: [SKILL](#skill) · [LangChain](#langchain) · [MCP](#mcp) · [n8n](#n8n).
+
 ### SKILL
 
-Markdown spec + JS handler. Put under `skill/`:
+Markdown spec + JS handler. Put under `skill/`. Full spec compliance and implementation details: [docs/AGENT_SKILLS_SPEC.md](docs/AGENT_SKILLS_SPEC.md).
 
 ```yaml
 # skill/SKILL.md
@@ -27,8 +100,6 @@ async function handler(args) {
 export default handler;
 ```
 
----
-
 ### LangChain
 
 Export a LangChain tool (e.g. `StructuredTool`). Put under `langchain/`:
@@ -49,11 +120,9 @@ class CalculatorTool extends StructuredTool {
 export default new CalculatorTool();
 ```
 
----
-
 ### MCP
 
-Declare MCP server in JSON. Put under `mcp/`; the server process is started by the hub:
+We do **not** provide MCP server implementation—we provide an **MCP client** that connects to existing MCP servers. Put a Cursor-style `mcp.json` under `mcp/`. To implement an MCP server, we recommend [**easy-mcp-server**](https://www.npmjs.com/package/easy-mcp-server).
 
 ```json
 // mcp/mcp.json
@@ -67,11 +136,9 @@ Declare MCP server in JSON. Put under `mcp/`; the server process is started by t
 }
 ```
 
----
-
 ### n8n
 
-Drop an n8n workflow JSON. Put under `n8n/`; the hub runs it (local or via API):
+Drop an n8n workflow JSON under `n8n/`. We run a local n8n server ([**@easynet/n8n-local**](https://www.npmjs.com/package/@easynet/n8n-local)) and call the instance directly—no API.
 
 ```json
 // n8n/workflow.json
@@ -87,43 +154,3 @@ Drop an n8n workflow JSON. Put under `n8n/`; the hub runs it (local or via API):
   "connections": {}
 }
 ```
-
----
-
-
-## Install
-
-```bash
-npm install @easynet/agent-tool-hub
-```
-
-Node 18+ required.
-
----
-
-## Use
-
-### CLI
-
-Copy `toolhub.example.yaml` to `toolhub.yaml` in your project (or use `-c path/to/config.yaml`), then:
-
-```bash
-npx agent-tool-hub scan    # load tools from configured roots
-npx agent-tool-hub verify  # scan and exit 1 on errors
-npx agent-tool-hub list    # list discovered tools
-```
-
-### In code
-
-Recommended — create and init in one call:
-
-```ts
-import { createAgentToolHub } from "@easynet/agent-tool-hub";
-
-const toolHub = await createAgentToolHub("toolhub.yaml");
-const result = await toolHub.invokeTool("utils.calculator", { expression: "1 + 2" });
-```
-
----
-
-See `toolhub.example.yaml` for config example and `examples/` for full tool layouts.

package/dist/{ToolRegistry-CcwUlxp9.d.cts → ToolRegistry-CN_IXOCr.d.cts}

@@ -193,4 +193,4 @@ declare class ToolRegistry {
     private deindexTool;
 }
 
-export { type BudgetConfig as B, type Capability as C, type Evidence as E, type ToolError as T, type ToolSpec as a, type ExecContext as b, ToolRegistry as c, type ToolAdapter as d, type ToolIntent as e, type ToolResult as f, type ToolKind as g, type CostHints as h, type ToolSearchQuery as i };
+export { type BudgetConfig as B, type Capability as C, type Evidence as E, type ToolSpec as T, type ToolResult as a, type ToolError as b, type ExecContext as c, ToolRegistry as d, type ToolAdapter as e, type ToolIntent as f, type ToolKind as g, type CostHints as h, type ToolSearchQuery as i };

package/dist/{ToolRegistry-CcwUlxp9.d.ts → ToolRegistry-CN_IXOCr.d.ts}

@@ -193,4 +193,4 @@ declare class ToolRegistry {
     private deindexTool;
 }
 
-export { type BudgetConfig as B, type Capability as C, type Evidence as E, type ToolError as T, type ToolSpec as a, type ExecContext as b, ToolRegistry as c, type ToolAdapter as d, type ToolIntent as e, type ToolResult as f, type ToolKind as g, type CostHints as h, type ToolSearchQuery as i };
+export { type BudgetConfig as B, type Capability as C, type Evidence as E, type ToolSpec as T, type ToolResult as a, type ToolError as b, type ExecContext as c, ToolRegistry as d, type ToolAdapter as e, type ToolIntent as f, type ToolKind as g, type CostHints as h, type ToolSearchQuery as i };