About Formhaus
@formhaus/mcp lets AI agents validate Formhaus form definitions against the actual @formhaus/core engine and simulate multi-step form paths. Offline checks need no account or key; separate tools handle Formhaus Cloud publishing and management.
Key features
- 01校验并修复表单定义
- 02模拟多步骤表单路径
- 03生成翻译模板
- 04查看字段与验证能力
- 05发布表单并管理提交
- 06管理表单设置和 Webhook
Use cases
- 01在上线前检查表单定义
- 02测试回答如何经过多步骤表单
- 03为表单生成翻译文件模板
- 04通过 Formhaus Cloud 发布及管理表单
MCP support
该 MCP 服务通过 stdio 向客户端提供表单校验、模拟等工具,并以 formhaus://capabilities 资源公开能力信息。云端发布和管理工具连接 Formhaus Cloud。
Configuration
Local server config is the same for every client. Copy it into your client’s MCP config file.
Tools
Local servers expose tools only once running on your machine, and the maintainer has not provided a tool list.
Details
From the project README@formhaus/mcp
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
| Tool | Input | Output |
|---|---|---|
validate_definition | definition (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_definition | definition (object or JSON string) | { definition, applied, valid, issues }: the definition with every safe fix applied, the fixes applied and the issues left |
simulate_path | definition, answers, optional actions (next, back, skip) and overlay | Active 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 |
capabilities | none | Field types, sections, repeatable groups, field props, validation rules, condition operators, step and route semantics, translation catalogs, keys and overlay addresses, adapters |
translation_template | definition, lang, optional prefix | overlay skeleton with the source texts, suggested file name and slots with address, key, placeholders and hash |
example_definitions | optional id | List of bundled examples, or one definition |
publish_form | definition, optional form_id, email, success_message, redirect_url | form_id, endpoint, hosted_url, embed_snippet, react_snippet, dashboard_url, warnings |
list_forms | none | Forms the API key reaches with status, version, submission count and endpoint |
get_submissions | form_id, optional limit, cursor | submissions and next_cursor |
update_form_settings | form_id, optional webhook_url, notify_mode, success_message, redirect_url, status | form_id, status, success_message, redirect_url, notify_mode, webhook_url, masked webhook_secret |
get_webhook | form_id | url and the masked secret |
reveal_webhook_secret | form_id | form_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
Comments
New to MCP?
From what the protocol is to installing your first server, these answers cover most first questions.
An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.