Connect Octonode
Connect your application, terminal, or AI assistant to an Octonode project.
Choose the connection that matches what you want to do. An access token authorizes API requests; the SDK defines executable nodes; MCP gives an AI assistant tools. You can use them together, but they serve different purposes.
Choose your integration
| You want to… | Use | Start here |
|---|---|---|
| Call Octonode from a backend or script | HTTP API and an access token | Access tokens and API calls |
| Build and run workflows on your machine | Octonode CLI | CLI reference |
| Write low-level executable TypeScript nodes | @octonode/plugin-runtime | TypeScript plugin runtime |
| Let an AI assistant inspect or edit a project | MCP and a scoped project key | MCP setup |
| Work with an LLM inside Studio | Assistant and a provider connection | AI assistants and skills |
| Package nodes and service integrations | Workflow plugins | Nodes and plugins |
| Publish a workspace app with its own page | Octonode Apps | Create an Octonode app |
| Teach an assistant a repeatable process | A project SKILL.md | Create a skill |
How the pieces connect
Your backend ─── access token + HTTP ───┐
├── Octonode API ── your project
AI assistant ── MCP + project key ─────┘
│
└── skills: instructions for using those tools
Local terminal ── CLI ── project manifest ── workflow runtime
│
nodes built with the SDK
│
plugin service credentialsThe CLI's run and invoke commands execute the local manifest. Setting API
environment variables configures API-backed MCP tools; it does not turn those
local CLI commands into remote commands.
Keep the three credentials separate
An Octonode access token authorizes requests to your Octonode deployment. Its scope controls which workspaces, projects, and actions are available.
An LLM provider credential authorizes model usage, such as a Claude connection. It does not grant access to your Octonode project. A local AI client needs its own provider setup as well as the Octonode MCP connection.
A plugin connection credential belongs to a service used by a workflow, such as a CRM. Configure it for the project that executes the workflow. It is not a replacement for either credential above.
A practical setup order
- Open the correct workspace and project in Studio.
- Create a key with the actions your integration needs. Begin with
projects:read; addprojects:writefor edits andworkflows:runfor execution. - Verify a read-only API request.
- Configure MCP if an assistant will use the project.
- Add the relevant skill and plugins, then validate before running.
These pages describe public product behavior and use placeholder credentials. Private workspace files, internal runbooks, and account secrets are not part of the Playbook.