Executor Documentation

Pages

1. OverviewWhat Executor exposes (CLI, web UI, HTTP API, MCP, SDK), runtime forms (local, cloud, self-host), and the shortest path from install to first tool call.
2. InstallationInstall the published CLI globally, bootstrap a development checkout, and verify the background service starts with expected ports and data directories.
3. QuickstartRun `executor install`, open the web UI, add a first integration, search and call a tool, and resume a paused execution.
4. MCP proxyHow Executor acts as a single MCP endpoint in front of OpenAPI, GraphQL, and upstream MCP integrations with shared auth and per-tool policies.
5. ToolsTool addresses, discovery, schema inspection, invocation paths, and how tools are produced per connection across CLI, HTTP API, and MCP surfaces.
6. IntegrationsTenant-level catalog identities for OpenAPI specs, GraphQL endpoints, MCP servers, and plugin-registered sources; detection, registration, and auth method descriptors.
7. ConnectionsOwner-scoped credentials bound to integrations, credential provider resolution, OAuth minting, and the `(owner, integration, name)` identity model.
8. PoliciesPer-tool allow, require-approval, and block actions; pattern matching, effective policy resolution, and default annotations derived from integration specs.
9. ExecutionsCode-mode execution via QuickJS, paused states for auth and approval, `execute` and `resume` HTTP routes, and MCP elicitation handling.
10. Add integrationsAdd OpenAPI, GraphQL, and MCP sources from the web UI or CLI, including spec URLs, namespaces, base URLs, and post-add verification with `tools sources`.
11. Connect MCP clientsWire Cursor, Claude Code, OpenCode, and other MCP clients via stdio (`executor mcp`) or streamable HTTP, including `add-mcp` setup and client restart requirements.
12. Configure credentialsCredential providers (file secrets, keychain, 1Password, encrypted stores), connection creation payloads, OAuth flows, and placement-based auth templates.
13. Manage policiesCreate and update owner-scoped tool policies, interpret effective policy precedence, and handle approval pauses from the web UI, MCP, and CLI resume flow.
14. Embed with the SDKCompose `createExecutor` with plugins and credential providers, register integrations, create connections, list and invoke tools, and shut down cleanly in application code.
15. Deploy self-hostedRun Executor in Docker or on Cloudflare Workers: image defaults, volume mounts, bootstrap admin env vars, TLS/public-origin requirements, and sandbox network constraints.
16. Executor CloudHosted Executor Cloud entry points, sign-in flow, shared MCP endpoint usage, and how cloud deployments differ from local daemon and self-host runtimes.
17. CLI referenceAll `executor` subcommands and flags: `install`, `web`, `daemon`, `service`, `mcp`, `call`, `resume`, `tools`, `server`, `login`, and auto-start behavior.
18. HTTP API referenceCore Executor HTTP API groups: `tools`, `integrations`, `connections`, `providers`, `executions`, `oauth`, and `policies` routes, payloads, and error shapes.
19. SDK reference`@executor-js/sdk` exports: `createExecutor`, plugin wiring, tool listing and invocation, connection APIs, policy helpers, typed IDs, and promise-mode entry points.
20. Configuration referenceEnvironment variables and runtime paths: `EXECUTOR_DATA_DIR`, `EXECUTOR_SCOPE_DIR`, `EXECUTOR_WEB_BASE_URL`, secret keys, bootstrap admin, ports, and client-specific overrides.
21. SDK quickstart exampleWalkthrough of `examples/docs-sdk-quickstart`: in-memory credential provider, OpenAPI `addSpec`, connection creation, tool listing, schema inspection, and shutdown.
22. Plugin catalogPublished protocol and provider plugins (OpenAPI, GraphQL, MCP, file-secrets, keychain, 1Password, Google, WorkOS Vault) and how `examples/all-plugins` wires them together.
23. Develop locallyMonorepo bootstrap, turbo dev servers, package boundaries, targeted Vitest runs, e2e boot recipes, and release-check scripts for contributors.
24. TroubleshootingCommon failure modes: daemon port conflicts, unreachable local server, OAuth login state behind proxies, stale Vite caches, missing bootstrap builds, and recovery commands.