Discover Onboard MCP tools, prompts, resources, agent skills, and marketplace asset paths.

Onboard MCP advertises 31 tools through tools/list. Prefer the intent-based workflow tools first. Use the [API] catalog and request tools when a workflow does not already cover the job.

Every advertised tool includes:

a human-readable title and input schema;
an outputSchema, with matching structured results in structuredContent;
explicit readOnlyHint, destructiveHint, and openWorldHint annotations.

Discovery sequence

Prefer workflow tools for common CS and onboarding jobs.
When you need a raw REST route, browse (browse_full_api / browse_inbox / list_projects) → explain → read_api_request or write_api_request.
Load resources (onboard://context/…) when path rules or field semantics are unclear.
Use built-in prompts when a playbook already matches the job.

Workflow tools

These tools resolve common Onboard concepts and return a consistent workflow envelope with an answer, resolved IDs, confidence, missing information, data, and suggested next actions.

Read and preview tools

Tool	What it does
`search_customers`	Finds customers from a partial name, domain, slug, or known ID.
`list_active_projects`	Lists active Projects across the signed-in account.
`get_kpi_dashboard`	Loads account KPI metrics and optional KPI drill-downs.
`get_customer_workspace_context`	Loads a customer and its active Projects.
`get_project_context`	Loads one Project with tasks, blockers, owners, and status.
`get_template_catalog`	Lists Project templates and the IDs needed to launch them.
`summarize_onboarding_status`	Summarizes scoped or account-wide onboarding progress.
`identify_project_risks`	Finds live risk signals such as overdue work and missing owners.
`find_blocked_tasks`	Finds at-risk open tasks; the API does not have a separate blocked status.
`recommend_next_steps`	Recommends follow-up tools and actions without executing them.
`post_project_update`	Creates a routing preview for a Project update; it never posts by itself.
`draft_customer_email`	Drafts a customer follow-up email without sending it.
`get_recent_inbox_messages`	Reads recent discussion messages visible to the signed-in user.
`list_signing_documents`	Lists signing templates, live envelopes, or signed documents.
`get_document_signing_detail`	Loads one signing document, signers, fields, and optional audit data.

Write tools

These tools can change Onboard data or communicate with participants. Workflow write tools default to a preview when they expose apply; review the preview before setting apply=true.

Tool	What it can change
`create_project_from_template`	Launches a persistent Project from a template.
`create_tasks`	Creates persistent Project tasks.
`update_task`	Changes task status, ownership, dates, or details.
`assign_owner`	Replaces a Project or task owner assignment.
`post_comment`	Posts a participant-visible comment on a Project task.
`send_document_for_signature`	Creates a live signing envelope and can email signers.
`manage_signing_document`	Voids an envelope or resends signer invitations.
`give_us_feedback`	Sends feedback and contact information to Onboard support.

REST API tools

Use these when the intent-based tools do not cover the required REST operation. The recommended sequence is browse → explain → read or write.

Human-readable docs for every route: API Reference. Machine-readable OpenAPI: /openapi.json.

Tool	Behavior
`browse_full_api`	Searches the complete published API catalog (API Reference).
`browse_inbox`	Searches Comments, Outboard, Stream, and Insights routes.
`list_projects`	Lists Project routes (called `roadmaps` in paths and `Map` in OpenAPI tags).
`create_template`	Returns template-building guidance and canonical routes; it does not create anything.
`explain_multiple_endpoints`	Explains inputs and outputs for several operations at once.
`explain_single_endpoint`	Explains one operation and its payload shape.
`read_api_request`	Executes only `GET`, `HEAD`, or `OPTIONS` against allowed Onboard hosts.
`write_api_request`	Executes `POST`, `PUT`, `PATCH`, or `DELETE` after endpoint review.

run_api_request and call_endpoint remain accepted as compatibility aliases for older clients, but they are not advertised by tools/list. New prompts, skills, and integrations should use read_api_request or write_api_request.

How to read the safety hints

Hint	Meaning in Onboard MCP
`readOnlyHint`	`true` only when the tool cannot change state.
`destructiveHint`	`true` when a result can be irreversible or difficult to reverse, including participant-visible sends.
`openWorldHint`	`true` when the tool can affect participant-visible Onboard state or an external recipient/system.

The hints describe capability, not authorization. Onboard still enforces the permissions of the API key or OAuth user, and configured request allowlists can further restrict raw REST writes.

Built-in prompts

Hosted HTTP advertises prompts by default. MCP clients that support prompts/list and prompts/get can discover these playbooks:

Prompt	Title	Purpose
`weekly_csm_summary`	Weekly CSM Summary	Prepare a weekly onboarding summary for one customer or portfolio slice.
`executive_status_report`	Executive Status Report	Generate an executive-ready onboarding status report.
`kickoff_plan_builder`	Kickoff Plan Builder	Create a project from implementation notes or kickoff inputs.
`implementation_risk_review`	Implementation Risk Review	Find implementation risks for a customer or project.
`stalled_customer_recovery`	Stalled Customer Recovery	Plan recovery for a stalled onboarding customer.
`signing_outstanding_review`	Signing Outstanding Review	Review in-progress signing envelopes and recommended follow-ups.
`send_library_document_for_signature`	Send Library Document for Signature	Send a Documents Library template for one-off signing (preview before apply).
`signing_compliance_audit`	Signing Compliance Audit	Load a signing envelope with compliance audit trail.
`signing_invitation_recovery`	Signing Invitation Recovery	Troubleshoot missing signing links and resend invitations.
`signed_documents_report`	Signed Documents Report	List and summarize completed signed documents.

Built-in resources

Clients that support MCP resources can load stable context via resources/list and resources/get:

URI	Purpose
`onboard://context/customer-schema`	Stable customer/account fields used by workflow tools.
`onboard://context/project-task-model`	How Onboard Project and task concepts map to the REST model (including path ID rules).
`onboard://context/template-catalog`	Template launch fields and preview-before-apply guidance.
`onboard://context/api-constraints`	Constraints for raw `[API]` read/write tools (hosts, methods, allowlists).

Agent skills / personas

Eight agent skills map personas to MCP tool sequences. Customer-facing narratives live on MCP use cases — AI agents. Implementers copy skills from the API repo:

Canonical: .agents/skills/onboard-agent-*
Mirrored: .claude/skills/ and .cursor/skills/
Playbook: docs/api/mcp-agent-tool-playbook.md

Skill directory	Persona
`onboard-agent-chief-of-staff`	Weekly executive rhythm and portfolio health
`onboard-agent-setup`	Configure Onboard (templates, branding, fields, bots)
`onboard-agent-onboarding`	Daily onboarding execution and nudges
`onboard-agent-review`	KPI and project health reviews
`onboard-agent-reporting`	Ad hoc extracts and cohort lists
`onboard-agent-product`	Capture and structure product feedback
`onboard-agent-opportunity`	Expansion and upsell signal scans
`onboard-agent-risk`	Churn, disengagement, and risk mitigations

Apps, marketplaces, and extras

Use these customer-facing surfaces to discover or extend Onboard with AI clients. For a custom remote connection, see MCP setup and MCP desktop clients.

Surface	What customers do
Hosted Onboard MCP	Connect Claude, ChatGPT / OpenAI Agent Builder, Cursor, Amazon Quick, and other MCP clients to `https://rest.onboard.io/mcp/sse` with your API key or OAuth.
MCP Registry	Look up Onboard as a remote MCP server (`io.github.viaonboard/onboard`) when your client browses the official registry.
ChatGPT / Codex	Use Onboard tools from ChatGPT-adjacent OpenAI surfaces when the Onboard app or connector is available in your workspace.
Ottie companion pet	Install Onboard’s ChatGPT / Codex pet for a branded workspace companion — Ottie — ChatGPT / Codex pet.

Starter prompts

Try these after your client lists Onboard tools:

Summarize my onboarding portfolio: wins, risks, blocked work, and next steps.

Find stalled or at-risk customers and recommend the highest-priority recovery actions.

Review outstanding signing documents, pending signers, and recommended follow-ups.

More patterns: MCP · MCP use cases — AI agents · Customer Success MCP.

MCP tools, prompts, and discovery