Onboarded

You can run the Onboarded MCP Server to let AI assistants access and act on Onboarded APIs. It discovers available operations, executes API calls with automatic authentication, remembers created entities for later reference, and can optionally read files from your local Onboarded repository. All credentials are stored securely and shared with the onboarded-cli so tokens never appear in MCP tool calls or responses.

How to use

Use an MCP client to interact with the Onboarded MCP Server. Discover available API operations, fetch detailed parameter info, and execute API calls with automatic authentication. The server persists entity references so your agent can later reference created IDs, and it can read files from your local Onboarded repository if you enable that feature.

How to install

Prerequisites you need before installing the MCP server:

• Node.js 18+
• git
• onboarded-cli — github.com/OnboardedInc/Onboarded-CLI

# Quick Setup (Recommended)

onboarded mcp setup

If you prefer a manual setup, clone, build, and register the server yourself. The following steps assume you are placing the server in a path you control.

# Clone and build
git clone https://github.com/OnboardedInc/onboarded-mcp.git /ABSOLUTE/PATH/TO/onboarded-mcp
cd /ABSOLUTE/PATH/TO/onboarded-mcp
npm install
npm run build

Add the MCP server to Warp's configuration.

{
  "mcpServers": {
    "onboarded": {
      "command": "node",
      "args": ["/ABSOLUTE/PATH/TO/onboarded-mcp/dist/index.js"]
    }
  }
}

Optionally configure the repository path for the repo_read tool (if you plan to read files from your Onboarded repo).

{
  "onboardedRepoPath": "/ABSOLUTE/PATH/TO/onboarded"
}

After completing the setup, restart Warp to load the MCP server and authenticate your profile.

Explicit MCP configuration (exact server command)

The server can be added to your local Warp MCP config as a stdio endpoint. The following configuration runs the local server using Node and the built index. This is the explicit, explicit command/argument form shown in setup steps.

{
  "mcpServers": {
    "onboarded": {
      "type": "stdio",
      "name": "onboarded",
      "command": "node",
      "args": ["/ABSOLUTE/PATH/TO/onboarded-mcp/dist/index.js"]
    }
  }
}

Available tools

spec_sync

Fetch and cache an OpenAPI spec from Onboarded APIs.

ops_search

Search for API operations by keyword across available APIs.

ops_describe

Get detailed parameter and schema information for a specific operation.

api_call

Execute a selected API operation by operationId with provided parameters and body.

auth_status

Check current authentication status for a given profile.

state_put

Store a reference to a created entity with its type and ID for later use.

state_query

Query stored entities using filters like type, environment, and name.

state_get

Retrieve a stored entity by internal or external identifiers.

state_delete

Remove an entity from local storage by its internal ID.

repo_read

Read a file from the configured local Onboarded repository.

repo_list

List files in a directory within the local Onboarded repository.