Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions docs/cloud/api-keys.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: API Keys
description: Authenticate to Executor Cloud.
---

This page will document cloud API key creation, rotation, and usage once the public flow is finalized.
6 changes: 6 additions & 0 deletions docs/cloud/hosting-model.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Hosting Model
description: Understand what runs in Executor Cloud.
---

This page will describe the hosted runtime boundaries for Executor Cloud.
6 changes: 6 additions & 0 deletions docs/cloud/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Overview
description: Understand Executor Cloud.
---

Executor Cloud provides hosted workspaces for shared sources, credentials, policies, and agent access.
6 changes: 6 additions & 0 deletions docs/cloud/sources.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Sources
description: Manage hosted source connections.
---

Cloud sources make shared tools available to the agents and applications connected to a workspace.
6 changes: 6 additions & 0 deletions docs/cloud/workspaces.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Workspaces
description: Organize shared Executor resources.
---

Workspaces group sources, policies, and credentials for a team or application.
8 changes: 8 additions & 0 deletions docs/concepts/connections.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Connections
description: OAuth and provider-backed credentials connected to Executor.
---

Connections represent authenticated relationships with external providers.

Use connections when a source needs provider-managed credentials, OAuth refresh behavior, or an identity label that users can recognize and manage separately from bare secrets.
6 changes: 6 additions & 0 deletions docs/concepts/executor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Executor
description: The runtime that connects sources, tools, auth, and policy.
---

An Executor is the runtime surface that applications and agents use to discover tools, inspect schemas, invoke tools, and resolve credentials.
6 changes: 6 additions & 0 deletions docs/concepts/policies.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Policies
description: Control which tools can run.
---

Policies decide whether tool invocations are allowed, blocked, or require approval.
6 changes: 6 additions & 0 deletions docs/concepts/scopes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Scopes
description: Resource ownership and precedence.
---

Scopes describe where resources belong and how Executor resolves resources across user, workspace, or organization boundaries.
6 changes: 6 additions & 0 deletions docs/concepts/secrets.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Secrets
description: Credential references shared by sources and tools.
---

Secrets store credentials separately from source definitions so tools can authenticate without exposing sensitive values.
6 changes: 6 additions & 0 deletions docs/concepts/sources.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Sources
description: External systems connected to Executor.
---

A source is an external system or protocol endpoint that contributes tools to Executor.
6 changes: 6 additions & 0 deletions docs/concepts/tools.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Tools
description: Callable actions exposed by sources.
---

A tool is a typed callable action with metadata, input schema, and invocation behavior.
93 changes: 93 additions & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "aspen",
"name": "Executor",
"colors": {
"primary": "#009f83",
"light": "#009f83",
"dark": "#6ee7c8"
},
"navigation": {
"tabs": [
{
"tab": "Getting Started",
"groups": [
{
"group": "Start Here",
"pages": [
"index",
"getting-started/overview",
"getting-started/local",
"getting-started/cloud",
"getting-started/sdk"
]
}
]
},
{
"tab": "Concepts",
"groups": [
{
"group": "Core Concepts",
"pages": [
"concepts/executor",
"concepts/sources",
"concepts/tools",
"concepts/scopes",
"concepts/policies",
"concepts/secrets",
"concepts/connections"
]
}
]
},
{
"tab": "SDK",
"groups": [
{
"group": "SDK",
"pages": [
"sdk/quickstart",
"sdk/create-executor",
"sdk/sources",
"sdk/tools",
"sdk/secrets",
"sdk/approvals",
"sdk/errors"
]
}
]
},
{
"tab": "Local",
"groups": [
{
"group": "Local Product",
"pages": [
"local/install",
"local/web-ui",
"local/mcp-server",
"local/cli",
"local/auth-and-secrets"
]
}
]
},
{
"tab": "Cloud",
"groups": [
{
"group": "Cloud Product",
"pages": [
"cloud/overview",
"cloud/workspaces",
"cloud/sources",
"cloud/api-keys",
"cloud/hosting-model"
]
}
]
}
]
}
}
8 changes: 8 additions & 0 deletions docs/getting-started/cloud.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Cloud Quickstart
description: Start with Executor Cloud.
---

Use Executor Cloud when your team needs shared workspaces, hosted source management, and centralized credentials.

This page will be filled in as the cloud onboarding flow stabilizes.
8 changes: 8 additions & 0 deletions docs/getting-started/local.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Local Quickstart
description: Start Executor locally.
---

Use the local product when you want Executor running on your machine with a web UI, CLI, and MCP server for local agents.

This page will be backed by a smoke-tested local workflow.
10 changes: 10 additions & 0 deletions docs/getting-started/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Overview
description: Choose the right Executor entrypoint.
---

Executor has three main entrypoints:

- Local product: run Executor on your machine and connect agents through MCP or the CLI.
- Cloud product: manage hosted workspaces, shared sources, and team-facing auth.
- SDK: embed Executor in your own TypeScript application through `@executor-js/sdk`.
8 changes: 8 additions & 0 deletions docs/getting-started/sdk.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: SDK Quickstart
description: Embed Executor with the SDK.
---

Use the SDK when you want to create an Executor instance inside your own TypeScript application.

All examples on this path should import the Executor API from `@executor-js/sdk`.
8 changes: 8 additions & 0 deletions docs/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Executor
description: Product and SDK documentation for Executor.
---

Executor gives AI agents one shared tool catalog, auth layer, and policy system across local, cloud, and SDK workflows.

These docs are scaffolded around realistic examples. SDK examples should compile against the public SDK packages before their snippets graduate into guide content.
6 changes: 6 additions & 0 deletions docs/local/auth-and-secrets.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Auth And Secrets
description: Manage local credentials.
---

This page will explain how local credentials are stored, resolved, and used by sources.
6 changes: 6 additions & 0 deletions docs/local/cli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: CLI
description: Use Executor from the command line.
---

The CLI starts local services, inspects tools, invokes tools, and manages runtime workflows.
6 changes: 6 additions & 0 deletions docs/local/install.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Install
description: Install and start Executor locally.
---

This page will cover local installation and startup commands.
6 changes: 6 additions & 0 deletions docs/local/mcp-server.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: MCP Server
description: Connect local agents to Executor through MCP.
---

Executor can run as an MCP server so compatible agents can use the same shared tool catalog.
6 changes: 6 additions & 0 deletions docs/local/web-ui.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Web UI
description: Manage sources, tools, secrets, and policies locally.
---

The local web UI is the fastest way to configure Executor on your machine.
6 changes: 6 additions & 0 deletions docs/sdk/approvals.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Approvals
description: Handle approval and elicitation requests.
---

Approvals let a tool ask for confirmation or additional input while it is being invoked.
6 changes: 6 additions & 0 deletions docs/sdk/create-executor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Create An Executor
description: Configure scopes, plugins, storage, and elicitation.
---

This page will explain the public `createExecutor` flow.
6 changes: 6 additions & 0 deletions docs/sdk/errors.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Errors
description: Handle SDK failures.
---

This page will document the public error behavior exposed by `@executor-js/sdk`.
70 changes: 70 additions & 0 deletions docs/sdk/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: Quickstart
description: Create an Executor, add a source, and inspect its tools.
---

import CreateExecutor from "/snippets/sdk/quickstart/create-executor.mdx";
import AddSource from "/snippets/sdk/quickstart/add-source.mdx";
import ListTools from "/snippets/sdk/quickstart/list-tools.mdx";
import InspectSchema from "/snippets/sdk/quickstart/inspect-schema.mdx";
import CloseExecutor from "/snippets/sdk/quickstart/close-executor.mdx";

{/* Code snippets on this page are generated from examples/docs-sdk-quickstart/src/main.ts. */}

The SDK lets you embed Executor in a TypeScript application.

This quickstart creates an Executor, loads an OpenAPI source from a local spec, lists the tools it contributed, and inspects one tool schema. The snippets on this page are generated from a runnable example in `examples/docs-sdk-quickstart`.

## Install

<CodeGroup>

```bash npm
npm install @executor-js/sdk @executor-js/plugin-openapi
```

```bash pnpm
pnpm add @executor-js/sdk @executor-js/plugin-openapi
```

```bash yarn
yarn add @executor-js/sdk @executor-js/plugin-openapi
```

```bash bun
bun add @executor-js/sdk @executor-js/plugin-openapi
```

</CodeGroup>

## Create An Executor

Import the SDK and configure the plugins you want to expose.

<CreateExecutor />

`onElicitation: "accept-all"` is convenient for scripts and examples. Applications with interactive approval flows should pass a handler instead.

## Add A Source

Sources add tools to the Executor catalog. This example registers an OpenAPI document under the `inventory` namespace.

<AddSource />

## List Tools

After a source is registered, its tools appear in the unified tool catalog.

<ListTools />

## Inspect A Tool

Tools expose schema metadata that agents and applications can use before invoking them.

<InspectSchema />

## Shut Down

Close the Executor when your process is done with it.

<CloseExecutor />
6 changes: 6 additions & 0 deletions docs/sdk/secrets.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Secrets
description: Store and reference credentials from SDK workflows.
---

Secrets let sources and tools use credentials without hard-coding sensitive values in source definitions.
6 changes: 6 additions & 0 deletions docs/sdk/sources.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Sources
description: Add MCP, OpenAPI, GraphQL, and other sources.
---

Sources turn external systems into tools that agents can discover and call.
Loading
Loading