Skip to content

docs(sdk): sync agent-vercel@1.0.0 #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Xaxis merged 1 commit into from
Sep 5, 2026
Merged

docs(sdk): sync agent-vercel@1.0.0 #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions src/pages/sdk/agent-vercel/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,15 @@ export const metadata = {
## Interfaces

- [AgentContext](interfaces/AgentContext.mdx)
- [FleetClient](interfaces/FleetClient.mdx)
- [OcToolInput](interfaces/OcToolInput.mdx)
- [OcToolWrapped](interfaces/OcToolWrapped.mdx)
- [PostActionResult](interfaces/PostActionResult.mdx)
- [StampToolCallInput](interfaces/StampToolCallInput.mdx)
- [VercelToolCall](interfaces/VercelToolCall.mdx)

## Functions

- [canonicalizeToolCall](functions/canonicalizeToolCall.mdx)
- [ocTool](functions/ocTool.mdx)
- [postActionToFleet](functions/postActionToFleet.mdx)
- [stampToolCall](functions/stampToolCall.mdx)
- [toolCallActionId](functions/toolCallActionId.mdx)
- [toolCallHash](functions/toolCallHash.mdx)
2 changes: 1 addition & 1 deletion src/pages/sdk/agent-vercel/functions/ocTool.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const metadata = {
function ocTool<TArgs, TResult>(input: OcToolInput<TArgs, TResult>): OcToolWrapped<TArgs, TResult>;
```

Defined in: [index.ts:192](https://github.com/orangecheck/oc-packages/blob/main/agent-vercel/src/index.ts#L192)
Defined in: [index.ts:189](https://github.com/orangecheck/oc-packages/blob/main/agent-vercel/src/index.ts#L189)

Wrap a tool() definition so its execute path is scope-checked and
envelope-emitting. The exact glue depends on which AI-SDK release you're
Expand Down
35 changes: 0 additions & 35 deletions src/pages/sdk/agent-vercel/functions/postActionToFleet.mdx
View file
Open in desktop

This file was deleted.

23 changes: 0 additions & 23 deletions src/pages/sdk/agent-vercel/interfaces/FleetClient.mdx
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion src/pages/sdk/agent-vercel/interfaces/OcToolWrapped.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ Defined in: [index.ts:142](https://github.com/orangecheck/oc-packages/blob/main/
| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| &lt;a id="property-description">&lt;/a> `description?` | `string` | - | [index.ts:145](https://github.com/orangecheck/oc-packages/blob/main/agent-vercel/src/index.ts#L145) |
| &lt;a id="property-execute">&lt;/a> `execute` | (`args`: `TArgs`, `ctx`: [`AgentContext`](AgentContext.mdx) & \&#123; `callId`: `string`; `fleet?`: [`FleetClient`](FleetClient.mdx); \&#125;) => `Promise`\&lt;\&#123; `action`: `ActionEnvelope`; `posted`: [`PostActionResult`](PostActionResult.mdx) \| `null`; `result`: `TResult`; \&#125;\> | The execute fn the AI SDK calls. Receives args + a callId (the AI SDK passes its own callId through — adapter glue passes it via context). Optional `fleet` field on the context tells the wrapper to fire-and-forget POST the stamped action to fleet. ochk.io/api/actions after the underlying execute() returns. | [index.ts:153](https://github.com/orangecheck/oc-packages/blob/main/agent-vercel/src/index.ts#L153) |
| &lt;a id="property-execute">&lt;/a> `execute` | (`args`: `TArgs`, `ctx`: [`AgentContext`](AgentContext.mdx) & \&#123; `callId`: `string`; \&#125;) => `Promise`\&lt;\&#123; `action`: `ActionEnvelope`; `result`: `TResult`; \&#125;\> | The execute fn the AI SDK calls. Receives args + a callId (the AI SDK passes its own callId through — adapter glue passes it via context). | [index.ts:151](https://github.com/orangecheck/oc-packages/blob/main/agent-vercel/src/index.ts#L151) |
| &lt;a id="property-parameters">&lt;/a> `parameters?` | `unknown` | - | [index.ts:144](https://github.com/orangecheck/oc-packages/blob/main/agent-vercel/src/index.ts#L144) |
| &lt;a id="property-verb">&lt;/a> `verb` | `string` | - | [index.ts:143](https://github.com/orangecheck/oc-packages/blob/main/agent-vercel/src/index.ts#L143) |
22 changes: 0 additions & 22 deletions src/pages/sdk/agent-vercel/interfaces/PostActionResult.mdx
View file
Open in desktop

This file was deleted.