Formio

The Form.io Agentic Coding Toolset

@formio/ai is what brings Form.io into your agentic coding environment. It provides a series of tools that enable any developer to perform a number of complex actions against the Form.io Enterprise Server using their favorite Agentic Coding toolsets. This turns the Form.io Enterprise Server into a Composable Backend for Agentically Coded Applications.

• Getting Started
• What you get
• Why this exists
• Agentic Skill Library
  • How it all works together
  • Orchestration skills
  • All skills
• Examples and Use Cases
  • Build complete applications
  • Build forms and wizards
  • Embed forms in existing applications
  • Work the REST API via prompt
• Using the MCP server without the skills
• MCP server tools
  • Forms
  • Roles
  • Actions
  • Project
  • Diagnostic
• Authentication
  • Login-form auto-resolution
• Environment variables
• Contributing
• License

Getting Started

To get started, open up your Terminal within your application folder, and then use one of the following methods to install this plugin within your application folder.

Option 1: Skills.sh Installation

npx skills add formio/ai

The command installs the skill library into .agents/skills/ folder within your application, which every skills-capable agent reads. It installs skills only — the Form.io MCP server, which is what gives the agent tools like form_create, form_list, and project_import, is connected on first use by the bundled formio-mcp-setup skill: it writes the MCP configuration for your client, asks you to approve it, and tells you to reload.

Option 2: Agent Plugin Installation

If your agent supports plugins, installing the plugin is an alternative to the command above. A plugin install already includes the skills and the MCP server:

Claude Code

/plugin marketplace add https://github.com/formio/ai.git
/plugin install formio-ai@formio

Cursor

Plugin installation coming soon

Codex

Plugin installation coming soon

Copilot

Plugin installation coming soon

Project Setup

Neither install route asks for a URL. Both are resolved per working directory, so one install can serve several projects, and the answer travels with the code rather than with your machine. The first Form.io tool call that needs a project reports what is missing and names the command that supplies it:

# What does this directory resolve to?
npx -y @formio/[email protected] project get --cwd "$(pwd)"

# Record it for this machine…
npx -y @formio/[email protected] project set --project-url "<project url>" --cwd "$(pwd)"

# …or commit it with the application, tracked in git and shared with everyone who clones it:
# write a formio.json in the application's own folder (the server reads it, never writes it)
echo '{ "projectUrl": "<project url>" }' > formio.json

The skills do this for you: each one calls the project_get tool before its first call — over the connection the server already has, not through a shell — and asks only for whichever value the server says is missing. Two values can be involved:

• Project URL — the endpoint for your project. On our SaaS environment (https://portal.form.io) that is a sub-domain such as https://myproject.form.io. Self-hosted, it depends on how your deployment routes projects: a sub-directory (https://forms.mysite.com/myproject) or a sub-domain of your own domain (https://myproject.mysite.com).
• Base URL — the endpoint for the deployment. On our SaaS environment it is always https://api.form.io — never your project's *.form.io sub-domain. Self-hosted, it is the deployment host, often a sub-domain of your own domain, e.g. https://forms.mysite.com.

You usually only supply the first. The Base URL is worked out from the Project URL wherever it can be — https://api.form.io for a *.form.io project, and the parent path for a sub-directory-routed one. The exception is the sub-domain routing case, where the project host and the deployment host differ by design and neither can be derived from the other; there the server asks for the Base URL explicitly rather than guessing.

Those derivations are also enforced: a *.form.io project paired with anything but https://api.form.io is refused, because for every project on our SaaS environment that pairing is a mistake that surfaces later as unexplained 404s or a portal login sent to a deployment you do not use. One deployment shape is indistinguishable from that mistake — an internal, non-SaaS deployment served from a *.form.io domain, which our QA team tests — so project set takes a --force flag for it:

npx -y @formio/[email protected] project set --force \
  --project-url "https://myproject.form.io" --base-url "https://api.internal.example" --cwd "$(pwd)"

--force requires both URLs in the same call: it records the pair you state, never one half completed from the record or by derivation. Every check is skipped for that pair — including the ones about a Project URL on its own — so what is recorded is exactly what you type. The pair is then honoured on every later read — project get reports it as forced rather than refusing it. It is deliberately a shell-only flag: the project_set tool does not take it, so no agent decides to waive a check.

The override belongs to the pair, not to the directory. Re-pointing the directory at a different project drops it and the checks apply again, while a write that leaves both halves untouched keeps it — an agent re-recording the project it already resolved must not undo your decision. That also means re-recording the same pair without --force changes nothing, so clearing the record is the way back:

npx -y @formio/[email protected] project set --reset --cwd "$(pwd)"

--reset removes this directory's entry from ~/.formio/projects.json — nothing else — and prints what the directory resolves to afterwards, which may still be a committed formio.json or the environment. It takes no URLs, exits 0 whenever the record was cleared (run project get to see whether the directory is serviceable), and is what every forced report names as the way to put the checks back.

To sign out, or to switch accounts, remove the cached login for the directory's deployment:

npx -y @formio/[email protected] project logout --cwd "$(pwd)"

project logout removes one deployment's token from ~/.formio/mcp-tokens.json — the deployment the directory resolves to, exactly as project get resolves it, or the one --base-url <url> names — and leaves every other entry in place. A running server notices on its next call there and opens the login page again, so no restart is needed. It exits 0 whether a token was removed or none was cached, and says which; 2 when the command could not answer, including a token cache it cannot read or write; 1 when nothing is mapped for the directory, as project get reports it, or when --base-url is not a valid URL; and 3 when a project resolved but its deployment could not be determined. In both of those cases --base-url names the deployment directly.

What you get

• Agent plugin: @formio/ai. One-command install wherever the agent has a marketplace — Claude Code, Cursor, GitHub Copilot CLI, VS Code, Codex. Bundles the MCP server and the skill library, and each client reads the manifest it understands.
• MCP server: @formio/mcp. Form.io operations (form_*, role_*, action_*, project_*) as MCP tools. Works with any MCP-aware client: Claude Code, Claude Desktop, VS Copilot, and whatever comes next.
• Skills library: Coding agent skills covering app orchestration, form building (webforms and wizards), form embedding, resource planning, JSON-schema authoring, action configuration, authentication & authorization, the @formio/js SDK surface, and the full Form.io REST surface.

Why this exists

Form.io has been the data standardization layer for enterprise data for a decade. With the proliferation of AI coding agents, that standardization matters more, not less.

Build on the Form.io platform, not from scratch. The agent builds complete applications including the data models, forms, workflows, and business logic. Form.io is the platform it builds on. The APIs, data patterns, RBAC, audit infrastructure, and form management capabilities are production-grade and already there. The agent uses them as tools to build applications better.

Standardization across every AI-built app. One model, one set of rules, one audit trail, regardless of which team or which agent built it. With a standardization layer, multiple teams ship multiple applications, all with defensible, reconcilable data layers across the enterprise.

Governance built in. RBAC, group permissions, change history, audit trails — all emitted on the first pass. Every app lands inside the same compliance envelope the enterprise already runs on.

Agentic Skill Library

The plugin ships an activatable skill library. Claude loads the relevant skill on demand based on what you ask — you rarely need to name one explicitly.

How it all works together

For the full picture — the skills architecture, how the orchestration skills dynamically load the other skills as an agent works through your prompt, how each flow reaches the Form.io Enterprise Server through the MCP server, and Mermaid diagrams of every process flow (building an application, extending one, building a form, embedding a form, changing a project, configuring auth) — read PROCESS.md.

Orchestration skills

Orchestration skills are special skills that serve as the entry point for most prompts. Rather than covering a single capability, they coordinate the other skills (planning, schema authoring, actions, deployment, framework scaffolding) to fulfill a broad, plain-language request end to end. When you describe what you want instead of which tool to use, an orchestration skill picks it up and drives the whole pipeline.

All skills

Examples and Use Cases

Ready-to-paste example prompts live in examples/ — each file is one self-contained prompt plus notes on what it should exercise. To try one, create a new folder, start Claude Code inside it, and paste the prompt:

mkdir form-app
cd form-app
claude
/plugin marketplace add https://github.com/formio/ai.git
/plugin install formio-ai@formio

Build complete applications

Create a brand-new 'greenfield' form-based application — or introduce a new form-based feature within an existing one — using the formio-application orchestration skill. The agent plans the data model, imports it into your Form.io project, and scaffolds the front end, using the Form.io platform as the composable backend for the full application logic.

• CRM Application — clients, deals, and activity logs with owner-scoped access.
• Help Desk — customer tickets, agent workflows, internal notes, and email notifications.
• Storyboard — Trello-style board → swimlane → story kanban with drag-and-drop ordering and team-based access.

This library currently only supports the Angular application framework for new 'greenfield' applications. It generally supports other frameworks using the Vanilla JS @formio/js javascript renderer. Full support for other frameworks are coming soon.

Build forms and wizards

Create complex forms and multi-page conditional wizards with the formio-form-builder skill. The agent authors the form JSON and automatically creates the form within any stage of your deployment — including forms whose submission data must adhere to well-defined external schemas such as FHIR.

• College Application Wizard — multi-page wizard with program-driven conditional pages.
• FHIR-Compliant Patient Form — submission data that conforms to the FHIR Patient resource.
• Customer Feedback Form — conditional follow-up fields and a conditional email notification.
• Student Onboarding Wizard — create a wizard and embed it within your application in one pass.

Embed forms in existing applications

Embed an existing form or wizard within any HTML-based application using the formio-form skill.

• Embed an Existing Form — render a saved form with @formio/js, pre-fill it, and handle submit events.

Work the REST API via prompt

The formio-api skill knows the full REST surface of your Form.io deployment — create any Resource, Form, Submission, or other entity via prompt.

• Create a Patient Resource — create a new resource through the MCP server's first-party tools.

Using the MCP server without the skills

The bundled MCP server is also published standalone as @formio/mcp — you do not need the agent plugin or the skill library to use it. Any MCP-aware client (Claude Code, Claude Desktop, Cursor, VS Code Copilot) can spawn the server directly and call the tools below.

It is also listed in the official MCP Registry as io.form/formio-mcp, so clients that browse the registry can discover and install it without any manual configuration.

Manual configuration

{
  "mcpServers": {
    "formio-mcp": {
      "command": "npx",
      "args": ["-y", "@formio/[email protected]"]
    }
  }
}

That is the JSON mcpServers shape — what Claude Code (.mcp.json), Cursor (.cursor/mcp.json), Claude Desktop, Windsurf, and Cline expect. Both the filename and the top-level key vary by client, so there is no universal .mcp.json.

Copilot uses servers, not mcpServers. In .vscode/mcp.json the top-level key is servers — everything inside the entry is identical.

{
  "servers": {
    "formio-mcp": {
      "command": "npx",
      "args": ["-y", "@formio/[email protected]"]
    }
  }
}

Codex takes TOML, and has no JSON equivalent:

[mcp_servers.formio-mcp]
command = "npx"
args = ["-y", "@formio/[email protected]"]

Authentication is the same everywhere: the first authenticated tool call opens the browser portal-login flow, or set the FORMIO_API_KEY environment variable beside FORMIO_PROJECT_URL — the key applies only to that project — to skip the browser entirely — required on any host with no browser, such as a cloud agent, a container, or CI.

Once connected, prompt the tools directly — no skill activation involved:

Using the formio-mcp tools, show me every form and role in my Form.io project, then export the full project template and save it to ./backup/template.json.

Using the formio-mcp form_create tool, create a new form called "Contact Us" with fields for full name (required), email (required), subject, and message, plus a submit button.

Ready-to-paste versions of these live in examples/mcp/: Inspect and Export a Project and Create a Form Directly.

One caveat: without the skills, the agent authors Form.io JSON (form schemas, action settings, access arrays) from its own general knowledge instead of the conventions the skill library encodes — every operation the tools cover still works, but you give up the guardrails. For other transports (Streamable HTTP for remote clients, SSE for Claude Desktop) and running the server from a clone of this repo, see the MCP server README.

MCP server tools

The bundled @formio/mcp server exposes these 25 tools. Skills prefer these over raw HTTP whenever an operation is covered.

Forms

Roles

Actions

Project

Diagnostic

Conventions every tool follows

• cwd. Every tool that resolves a project takes an optional cwd and resolves for one directory on each call, chosen in this order: the cwd argument; the client's workspace roots, when the client declares the MCP roots capability — one root as is, and with several the roots holding a project record (a committed formio.json or a directory mapping, a broken one included) decide — the first of them when they all hold the same record, the next source when none holds one, and a refusal with INVALID_ARGUMENT listing them when they hold different records; the CLAUDE_PROJECT_DIR environment variable, when it is an absolute path; and last the server process's own working directory, which is fixed where the client spawned it. Roots are read once per session and again after notifications/roots/list_changed; a roots/list that fails or does not answer within 2 seconds leaves the last good list in use, and counts as no roots only when no read has succeeded. project_get and server_status report the source as cwdSource (argument, client-root, claude-project-dir or server). Pass cwd, as an absolute path, when cwdSource is server or claude-project-dir — both guesses at where the user is — or to target another directory — such as one application in a monorepo that keeps a formio.json per app.
• formId and formIdOrPath. formId is always a form's 24-character ObjectId _id. formIdOrPath takes the _id or the form's path, and only the reads Form.io serves by path take it: form_get, form_revision_list and form_revision_get. A path passed as formId is refused with INVALID_ARGUMENT; read the form's _id with form_get.
• Lists. form_list, role_list, action_list and form_revision_list take limit (default 100), skip, sort and select. Each returns its items under its own key (forms, roles, actions, revisions) beside total, the number of items the whole query matches, and hasMore, which is true while another page exists: call again with a larger skip until it is false. When Form.io does not report a total, total is absent and hasMore is true whenever the page came back full. action_type_list returns its actionTypes the same way, always with hasMore: false.
• Updates overwrite what they send. form_update, role_update and action_update send a PUT, which Form.io applies to the stored document: each field in the body overwrites the stored one, and a top-level field left out keeps its stored value. An array or object in the body is stored as given — it replaces the stored one whole rather than merging into it — so send every component, access entry or setting the field should keep.
• Revision history. A form_create or form_update that would save without revision history — the deployment is not licensed for revisions, the body sets revisions: "", or an update targets a form whose revisions are off — is refused with HISTORY_NOT_ACCEPTED and writes nothing, unless the call passes acceptNoHistory: true. The server never prompts the user itself: the agent relays the refusal, and retries with the user's answer. Drafts, form_publish and form_revert need the revisions licence and are refused with LICENSE_REQUIRED without it.
• Errors. A failed call returns isError: true, with text that starts with the error's code in brackets — [NOT_FOUND] … — followed by the message, and _meta["io.form/error"]: { code, status?, body? }, where status is Form.io's HTTP status and body its response body, truncated to 2,000 characters. An error result carries no structuredContent. The codes are NOT_CONFIGURED, BASE_URL_UNRESOLVED, CONFIG_UNREADABLE, INVALID_ARGUMENT, AUTH_REQUIRED, FORBIDDEN, NOT_FOUND, VALIDATION_FAILED, LICENSE_REQUIRED, HISTORY_NOT_ACCEPTED, NO_DRAFT, UNKNOWN_ACTION_TYPE, REDIRECTED, UPSTREAM_ERROR, NETWORK_ERROR and INTERNAL. An argument that fails the tool's input schema is reported by the MCP SDK as plain text, without a code.

Authentication

The MCP server supports two authentication modes:

• JWT mode (default). A short-lived local Express server renders the Form.io portal login form; the user signs in once, the JWT comes back via a /callback endpoint, and formioFetch attaches x-jwt-token on every subsequent request. The flow is implicit — the first authenticated tool call triggers it on a cache miss. No explicit authenticate tool exists.
• API-key mode. Set the FORMIO_API_KEY environment variable beside FORMIO_PROJECT_URL. Requests to the project FORMIO_PROJECT_URL names attach x-token and skip the browser flow entirely; any other project a committed formio.json or a directory mapping resolves authenticates through the portal login instead, and project_get says why.

Login-form auto-resolution

When FORMIO_LOGIN_FORM is unset, the server probes these candidates on the first login attempt and caches the first one that responds (1.5-second timeout per candidate):

1. {baseUrl}/formio/user/login (portal-base)
2. {projectUrl}/admin/login (project admin)
3. {projectUrl}/user/login (project user)

The probe runs lazily — only when the local auth page is actually served.

Environment variables

* Not at startup — the server starts and lists every tool without it, and only errors when a tool actually needs a project. The alternative is the project_set tool, which maps a working directory to a project in ~/.formio/projects.json so one server can serve several workspaces. Resolution runs by scope, narrowest first: a committed formio.json found by walking up from the caller's cwd, then the mapping for that cwd or its nearest mapped ancestor, then FORMIO_PROJECT_URL in the environment as the weakest source, then the error. Map a directory before any client connects with npx -y @formio/[email protected] project set --project-url <url> --cwd <path> — the deployment is derived from the project URL wherever it can be, so add --base-url <url> only when the server says it cannot be determined. Add --force beside both URLs to record a pair the domain rules refuse — the one shape they cannot tell from a mistake is an internal deployment served from a *.form.io domain; it takes both URLs in the same call, is honoured on every later read, and is a shell-only flag the project_set tool does not have. project set --reset --cwd <path> clears a directory's entry, which is how a forced pair is un-forced: a write that leaves both halves untouched keeps the override, so there is nothing for an unforced re-record to change. project get --cwd <path> prints what resolves and which source won, exiting 0 when it resolved, 1 when nothing is mapped, 2 when the command itself failed, and 3 when a project resolved but its Base URL could not be determined — the half-configured directory, repaired by supplying that one value. project set --cwd <path> exits 0 when the directory is ready to serve a call, 1 when a named value is still missing, 2 when the command could not answer, and 3 when the record WAS written and the directory still resolves no Base URL — a committed formio.json governs it and supplies none, so the remedy is an edit to that file rather than another write.

Contributing

This is a pnpm + Turborepo monorepo: the @formio/mcp MCP server (packages/mcp-server/), the @formio/ai agent plugin (plugin/, bundling the server + skill library), and the skill test suite (packages/skill-tests/). Setup, conventions, skill-authoring guidelines, and the release flow are in CONTRIBUTING.md. How the skills and the MCP server fit together at runtime is in PROCESS.md. Security reports: SECURITY.md.

License

MIT