Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

fix(docs): correct tool documentation links (#36)

Boris Besemer3f1f880893d8
diff --git a/docs/tools/human-in-the-loop.md b/docs/tools/human-in-the-loop.md
index 03b9dd525..a9b0af5b6 100644
--- a/docs/tools/human-in-the-loop.md
+++ b/docs/tools/human-in-the-loop.md
@@ -13,7 +13,7 @@ Either way the run parks at `session.waiting`, durably, for as long as it takes
## Approvals
-Approval is a property of a [tool](./overview) that pauses for a person before it runs. Gate a tool with `needsApproval` and the helpers from `eve/tools/approval`:
+Approval is a property of a [tool](/docs/tools) that pauses for a person before it runs. Gate a tool with `needsApproval` and the helpers from `eve/tools/approval`:
```ts title="agent/tools/refund_charge.ts"
import { defineTool } from "eve/tools";
@@ -54,7 +54,7 @@ The built-in `ask_question` tool lets the model pause and ask the user, rather t
- `options`: an optional list of choices to offer. Channels render these as buttons or a select menu.
- `allowFreeform`: whether the user may answer with free text instead of picking an option.
-`ask_question` is part of the [default harness](../concepts/default-harness), so it is available without you defining anything. It produces the same `input.requested` pause as an approval, and resumes the same way.
+`ask_question` is part of the [default harness](/docs/concepts/default-harness), so it is available without you defining anything. It produces the same `input.requested` pause as an approval, and resumes the same way.
## How pause and resume works
@@ -67,17 +67,17 @@ Approvals and questions share one protocol:
The run picks back up exactly where it parked. Because the pause is durable, nothing is held in memory while it waits — the process can restart and the parked turn survives.
-See [Sessions, runs & streaming](../concepts/sessions-runs-and-streaming) for the full event and resume contract that this builds on.
+See [Sessions, runs & streaming](/docs/concepts/sessions-runs-and-streaming) for the full event and resume contract that this builds on.
## Answering from a client or channel
-Channels turn requests into native UI: the Slack adapter renders approvals as buttons and questions as select menus, and writes the user's choice back as the answer. You get this for free on every [channel](../channels).
+Channels turn requests into native UI: the Slack adapter renders approvals as buttons and questions as select menus, and writes the user's choice back as the answer. You get this for free on every [channel](/docs/channels).
-From your own frontend, read the pending request off the latest message and answer through the same session — see [Building a frontend](../guides/frontend/overview#human-in-the-loop-prompts) for the client-side reducer and `inputResponses` shape.
+From your own frontend, read the pending request off the latest message and answer through the same session — see [Building a frontend](/docs/guides/frontend/overview#human-in-the-loop-prompts) for the client-side reducer and `inputResponses` shape.
## What to read next
-- [Tools](./overview): define the typed actions an approval gates
-- [Default harness](../concepts/default-harness): the built-in tools, including `ask_question`
-- [Sessions, runs & streaming](../concepts/sessions-runs-and-streaming): the event and resume contract behind the pause
-- [Building a frontend](../guides/frontend/overview): render and answer requests from your own UI
+- [Tools](/docs/tools): define the typed actions an approval gates
+- [Default harness](/docs/concepts/default-harness): the built-in tools, including `ask_question`
+- [Sessions, runs & streaming](/docs/concepts/sessions-runs-and-streaming): the event and resume contract behind the pause
+- [Building a frontend](/docs/guides/frontend/overview): render and answer requests from your own UI
diff --git a/docs/tools/overview.mdx b/docs/tools/overview.mdx
index a2c5386ce..c43637a02 100644
--- a/docs/tools/overview.mdx
+++ b/docs/tools/overview.mdx
@@ -4,7 +4,7 @@ description: "Define typed actions the agent can call, and gate sensitive ones o
url: /tools
---
-A tool is a typed action the agent can call, such as hitting an API, running a query, or writing a file. The action stays in code you control. Tools run in your app runtime with full access to `process.env`, not in the [sandbox](../sandbox).
+A tool is a typed action the agent can call, such as hitting an API, running a query, or writing a file. The action stays in code you control. Tools run in your app runtime with full access to `process.env`, not in the [sandbox](/docs/sandbox).
## Define a tool
@@ -37,8 +37,8 @@ When a tool returns structured data, add an optional `outputSchema`. With Zod or
`execute` gets a `ctx` carrying the runtime accessors:
- `ctx.session`: session metadata, turn, auth, parent lineage.
-- `ctx.getSandbox()`: the live [sandbox](../sandbox) handle.
-- `ctx.getSkill(id)`: read a packaged [skill](../skills)'s metadata and files.
+- `ctx.getSandbox()`: the live [sandbox](/docs/sandbox) handle.
+- `ctx.getSkill(id)`: read a packaged [skill](/docs/skills)'s metadata and files.
Running in the app runtime is what lets a tool import shared code from `lib/`, read `process.env`, and take part in eve’s durable pause/resume model.
@@ -82,7 +82,7 @@ Do not return secrets, credentials, unnecessary personal data, or unbounded sens
## What to read next
- [Human-in-the-loop](./human-in-the-loop): gate a tool on approval, or have the agent ask a question
-- [Skills](../skills): on-demand procedures the model loads when relevant
-- [Default harness](../concepts/default-harness): the built-in tools and how to override or disable them
-- [Dynamic capabilities](../guides/dynamic-capabilities): tools whose set is resolved per session with `defineDynamic`
-- [Auth & route protection](../guides/auth-and-route-protection): authenticate a tool to an external service
+- [Skills](/docs/skills): on-demand procedures the model loads when relevant
+- [Default harness](/docs/concepts/default-harness): the built-in tools and how to override or disable them
+- [Dynamic capabilities](/docs/guides/dynamic-capabilities): tools whose set is resolved per session with `defineDynamic`
+- [Auth & route protection](/docs/guides/auth-and-route-protection): authenticate a tool to an external service