@formhaus/mcp

中文文档
0.15.3发布于 2026/11/03MITTypeScriptES Module构建来源已验证近 30 天下载 8024

MCP server for authoring and checking Formhaus form definitions: validation, path simulation and capabilities.

原始使用文档
文档目录3 节
  1. Setup
  2. Tools
  3. License

@formhaus/mcp

formhaus-dev/formhaus MCP server

MCP server that lets AI agents check Formhaus form definitions against the real @formhaus/core engine. Runs over stdio. Requires Node 22.12 or later. The checks need no account or key.

validate_definition, fix_definition, simulate_path, translation_template, capabilities and example_definitions run offline. The other tools publish forms, read submissions and manage settings in Formhaus Cloud. If the app has its own backend, keep the data there and don't publish without the user's consent.

Setup

Claude Code plugin, with the Formhaus skills:

claude plugin marketplace add formhaus-dev/formhaus
claude plugin install formhaus@formhaus

Inside a Claude Code session, /plugin marketplace add formhaus-dev/formhaus and /plugin install formhaus@formhaus do the same after a confirmation prompt.

Claude Code, server only:

claude mcp add formhaus -- npx -y @formhaus/mcp

Claude Desktop (claude_desktop_config.json) and Cursor (.cursor/mcp.json):

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

Tools

ToolInputOutput
validate_definitiondefinition (object or JSON string){ valid, issues }. Each issue has code, severity, a JSON pointer path, message, hint and, when a repair is known, fixes ({ title, safe, patch } with an RFC 6902 JSON Patch)
fix_definitiondefinition (object or JSON string){ definition, applied, valid, issues }: the definition with every safe fix applied, the fixes applied and the issues left
simulate_pathdefinition, answers, optional actions (next, back, skip) and overlayActive step path with visible fields, action trace, validation ({ valid, issues }), field errors, wouldSubmit, submitValues. Group item fields appear as paths such as participants.0.email
capabilitiesnoneField types, sections, repeatable groups, field props, validation rules, condition operators, step and route semantics, translation catalogs, keys and overlay addresses, adapters
translation_templatedefinition, lang, optional prefixoverlay skeleton with the source texts, suggested file name and slots with address, key, placeholders and hash
example_definitionsoptional idList of bundled examples, or one definition
publish_formdefinition, optional form_id, email, success_message, redirect_urlform_id, endpoint, hosted_url, embed_snippet, react_snippet, dashboard_url, warnings
list_formsnoneForms the API key reaches with status, version, submission count and endpoint
get_submissionsform_id, optional limit, cursorsubmissions and next_cursor
update_form_settingsform_id, optional webhook_url, notify_mode, success_message, redirect_url, statusform_id, status, success_message, redirect_url, notify_mode, webhook_url, masked webhook_secret
get_webhookform_idurl and the masked secret
reveal_webhook_secretform_idform_id and the full webhook_secret. Marked as a non-read-only, sensitive tool. Whether the client asks first depends on its permission settings

publish_form, list_forms, get_submissions, update_form_settings, get_webhook and reveal_webhook_secret call Formhaus Cloud at https://api.formhaus.dev. All but publish_form need FORMHAUS_API_KEY in the server environment, and publish_form uses it when set. An account key (fh_live_...) reaches every form and all six tools. An agent key (fh_agent_..., returned once by the first keyless publish_form) reaches only the forms it created, and update_form_settings, get_webhook and reveal_webhook_secret need an account key. The server reads FORMHAUS_API_KEY from its own environment, not from the project .env. Add it to the env of the formhaus server in your MCP client config (for example .mcp.json with ${FORMHAUS_API_KEY} and the value in your shell or a gitignored .env your client loads), then restart the server. FORMHAUS_API_BASE overrides the API URL. The server also sends short usage instructions to the client on connect.

simulate_path applies answers as initial values, with group answers as arrays of item objects, then presses the actions in order, or Next until the last step or the first blocking error. errors covers visited steps only. Custom validators, onStepValidate and lifecycle hooks are not run. The capabilities are also available as the formhaus://capabilities resource.

The tool handlers are exported for use without MCP:

import { simulatePathTool, validateDefinitionTool } from '@formhaus/mcp';

const report = await validateDefinitionTool({ definition });
const result = await simulatePathTool({ definition, answers: { kind: 'business' } });

See the MCP guide for example output. A remote MCP server for Formhaus Cloud is also available. npx formhaus sets up the server in the coding agents on your machine; see formhaus.

License

MIT

版本与发布记录

@formhaus/mcp 共发布 55 个版本,首次发布于 2026/10/09;过去 12 个月发布了 55 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.15.3latest2026/11/0313 天前
0.15.22026/11/0313 天前
0.15.12026/11/0213 天前
0.15.02026/11/0213 天前
0.14.02026/11/0213 天前
0.13.32026/11/0114 天前

关于 @formhaus/mcp 的常见问题

@formhaus/mcp 是什么?

MCP server for authoring and checking Formhaus form definitions: validation, path simulation and capabilities.

如何安装 @formhaus/mcp?

在项目目录运行 npm install @formhaus/mcp,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 formhaus-mcp,可以用 npx formhaus-mcp 直接运行。

@formhaus/mcp 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@formhaus/mcp 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@formhaus/mcp 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.12。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@formhaus/mcp 可以商用吗?

@formhaus/mcp 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@formhaus/mcp 的下载量有多少?

根据 npm 官方下载统计,@formhaus/mcp 在 2026/10/16 – 2026/11/14 这 30 天内被下载 8,024 次,日均约 267 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@formhaus/mcp 还在维护吗?

最新版本 0.15.3 发布于 2026/11/03(13 天前);至今共发布 55 个版本,其中过去 12 个月发布了 55 个;首次发布于 2026/10/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。