# @formhaus/mcp 中文文档

规范地址：https://npmcn.com/package/%40formhaus/mcp/

版本：0\.15\.3
npm 元数据更新时间：2026-11-02T20:11:10.184Z
中文译文更新时间：2026-11-15T08:53:57.368Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40formhaus/mcp
原文对照：https://npmcn.com/package/%40formhaus/mcp/?lang=original
项目主页：https://formhaus.dev/guide/mcp.html
源码仓库：https://github.com/formhaus-dev/formhaus

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：301 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.12
- 运行依赖：4 个
- 首次发布：2026-10-09T08:16:00.771Z
- 最新版本发布：2026-11-02T20:11:09.697Z
- 近 30 天下载量：8024（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：55（近 12 个月 55 个）

## 中文简介

MCP服务器用于编写并检查Formhaus形式定义:验证,路径模拟和能力.

## 安装

```sh
npm install @formhaus/mcp
```

也可以使用：`pnpm add @formhaus/mcp`、`yarn add @formhaus/mcp`、`bun add @formhaus/mcp`

## README

# @ formaus/ mcp (中文(简体) )

[![formhaus-dev/formhaus MCP server](https://glama.ai/mcp/servers/ignsm/formhaus/badges/score.svg)](https://glama.ai/mcp/servers/ignsm/formhaus)

允许 AI 代理检查的 MCP 服务器 [福伦豪斯](https://github.com/formhaus-dev/formhaus) 形式定义相对于真实 `@formhaus/core` 发动机。 跑过Stdio。 要求节点22.12或更晚. 检查不需要账户或钥匙.

`validate_definition`, (中文(简体) ), `fix_definition`, (中文(简体) ), `simulate_path`, (中文(简体) ), `translation_template`, (中文(简体) ), `capabilities` 财务报告和审定财务报表 `example_definitions` 运行离线。 其他工具发布表格、阅读提交文件和管理设置 [福尔豪斯云](https://formhaus.dev/cloud/overview). 如果该应用程序有自己的后端,则保留该数据,未经用户同意不得发布.

## 设置

Claude 代码插件, 具有 Formhaus 技能 :

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

在克劳德代码会话中, `/plugin marketplace add formhaus-dev/formhaus` 财务报告和审定财务报表 `/plugin install formhaus@formhaus` 在确认后做同样的事情.

Claude Code, 只有服务器:

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

Claude 桌面 (`claude_desktop_config.json`)和光标(`.cursor/mcp.json`:

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

## 工具

| 工具 | 投入 | 产出 |
| --- | --- | --- |
| `validate_definition` | `definition` (对象或JSON字符串) | `{ valid, issues }`每个问题都有: `code`, (中文(简体) ), `severity`一个JSON指针 `path`, (中文(简体) ), `message`, (中文(简体) ), `hint` 当有修行者知道的时候, `fixes` (单位:千美元)`{ title, safe, patch }` 有RFC 6902 JSON补丁) |
| `fix_definition` | `definition` (对象或JSON字符串) | `{ definition, applied, valid, issues }`:每个安全装置都适用的定义、适用的固定装置和遗留的问题 |
| `simulate_path` | `definition`, (中文(简体) ), `answers`选项 `actions` (单位:千美元)`next`, (中文(简体) ), `back`, (中文(简体) ), `skip`和 `overlay` | 有可见字段的主动步骤路径,动作跟踪, `validation` (单位:千美元)`{ valid, issues }`),字段 `errors`, (中文(简体) ), `wouldSubmit`, (中文(简体) ), `submitValues`组合项目字段作为路径显示,例如 `participants.0.email` |
| `capabilities` | 无 | 字段类型、段、可重复组、字段道具、验证规则、条件操作符、步骤和路由语义、翻译目录、密钥和重叠地址、适配器 |
| `translation_template` | `definition`, (中文(简体) ), `lang`选项 `prefix` | `overlay` 建议使用源文本的模板 `file` 名称和 `slots` 有地址、钥匙、占位符和散列 |
| `example_definitions` | 选项 `id` | 捆绑实例列表, 或一个定义 |
| `publish_form` | `definition`选项 `form_id`, (中文(简体) ), `email`, (中文(简体) ), `success_message`, (中文(简体) ), `redirect_url` | `form_id`, (中文(简体) ), `endpoint`, (中文(简体) ), `hosted_url`, (中文(简体) ), `embed_snippet`, (中文(简体) ), `react_snippet`, (中文(简体) ), `dashboard_url`, (中文(简体) ), `warnings` |
| `list_forms` | 无 | 格式化 API 密钥到达状态、 版本、 提交数和终点 |
| `get_submissions` | `form_id`选项 `limit`, (中文(简体) ), `cursor` | `submissions` 财务报告和审定财务报表 `next_cursor` |
| `update_form_settings` | `form_id`选项 `webhook_url`, (中文(简体) ), `notify_mode`, (中文(简体) ), `success_message`, (中文(简体) ), `redirect_url`, (中文(简体) ), `status` | `form_id`, (中文(简体) ), `status`, (中文(简体) ), `success_message`, (中文(简体) ), `redirect_url`, (中文(简体) ), `notify_mode`, (中文(简体) ), `webhook_url`遮盖 `webhook_secret` |
| `get_webhook` | `form_id` | `url` 和被蒙上头罩 `secret` |
| `reveal_webhook_secret` | `form_id` | `form_id` 和全文 `webhook_secret`。标记为一个不只读而敏感的工具。 客户端是否首先询问取决于其权限设置 |

`publish_form`, (中文(简体) ), `list_forms`, (中文(简体) ), `get_submissions`, (中文(简体) ), `update_form_settings`, (中文(简体) ), `get_webhook` 财务报告和审定财务报表 `reveal_webhook_secret` 呼叫云层 `https://api.formhaus.dev`。 。 。 `publish_form` 需求 `FORMHAUS_API_KEY` 在服务器环境中,以及 `publish_form` 设定时使用。 账户密钥( E)`fh_live_...`)达到每一种形式和所有六种工具. 一个代理密钥( A)`fh_agent_...`,第一个无键返回一次 `publish_form`只能达到它创造的形式 `update_form_settings`, (中文(简体) ), `get_webhook` 财务报告和审定财务报表 `reveal_webhook_secret` 需要一个账户密钥。 服务器读取 `FORMHAUS_API_KEY` 从自己的环境,而不是从项目 `.env`添加到 `env` 在您的 MCP 客户端配置中的窗体服务器( 例如) `.mcp.json` 与 `${FORMHAUS_API_KEY}` 和您外壳中的值或被忽略的值 `.env` 然后重新启动服务器. `FORMHAUS_API_BASE` 覆盖 API URL。 服务器还在连接时向客户端发送了简短的使用指令.

`simulate_path` 应用 `answers` 作为初始值,将组合答案作为项目对象的数组,然后按顺序排列动作,或直到最后一步或第一个阻断错误. `errors` 仅涵盖访问的步骤。 自定义验证符, `onStepValidate` 和生命周期悬钩没有运行。 这些能力也可用于: `formhaus://capabilities` 资源.

工具处理器导出用于不使用 MCP :

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

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

见 [MCP 指南](https://formhaus.dev/guide/mcp) 例如输出。 A 类 [远程 MCP 服务器](https://formhaus.dev/cloud/mcp) 因为Formhaus Cloud也可用. `npx formhaus` 在机器上的编码代理设置服务器;见 [`formhaus`](https://www.npmjs.com/package/formhaus)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @formhaus/mcp 是什么？

MCP服务器用于编写并检查Formhaus形式定义:验证,路径模拟和能力\.

### 如何安装 @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 和提交记录判断。