niceform-mcp

niceform-mcp-server

适用于 niceform.ai 的 MCP（Model Context Protocol）服务——可从任何兼容 MCP 的客户端创建 AI 驱动的表单：Claude Desktop、Claude Code、Cursor、VS Code（GitHub Copilot）、Windsurf、OpenAI Codex、Gemini CLI 等。

功能

提供九种工具，让 Agent 可以端到端地处理表单：

• create_form - 根据自然语言描述生成表单
• publish_form - 发布表单，使其上线并可公开访问
• close_form - 停止接收回复
• list_forms - 列出你的表单
• get_form - 获取表单的字段和状态
• get_preview_url - 在发布前预览表单
• list_form_responses - 获取你拥有的表单的分页提交记录
• summarize_responses - 汇总表单的回复
• export_responses_csv - 将回复导出为 CSV

通过 URL 连接（无需安装）

niceform.ai 也在 https://www.niceform.ai/api/mcp 托管此服务（streamable HTTP）。请将 API 密钥作为 Authorization: Bearer <API key> 发送。

claude mcp add --transport http niceform https://www.niceform.ai/api/mcp --header "Authorization: Bearer nf_live_your_api_key_here"

Cursor（~/.cursor/mcp.json）：

{ "mcpServers": { "niceform": { "url": "https://www.niceform.ai/api/mcp", "headers": { "Authorization": "Bearer nf_live_your_api_key_here" } } } }

VS Code（.vscode/mcp.json）：

{ "servers": { "niceform": { "type": "http", "url": "https://www.niceform.ai/api/mcp", "headers": { "Authorization": "Bearer nf_live_your_api_key_here" } } } }

Claude Desktop：请使用下方的 npx 配置。更多信息：https://www.niceform.ai/mcp

要求

• Node.js 18 或更高版本（服务通过 npx 在本地运行，因此无需安装其他内容）
• niceform.ai API 密钥
• 支持本地（stdio）服务的 MCP 客户端。请参阅支持的客户端。

获取 API 密钥

1. 登录 niceform.ai
2. 前往 设置 → API Keys
3. 创建新的 API 密钥
4. 复制密钥。密钥只会显示一次。

环境变量

变量	必需	描述
NICEFORM_API_KEY	是	你的 niceform.ai API 密钥（nf_live_...）
NICEFORM_API_URL	否	API 基础 URL（默认为 https://www.niceform.ai）

支持的客户端

此服务适用于任何能够运行本地命令的 MCP 客户端，无论客户端使用哪种 LLM。在以下所有示例中，请将 nf_live_your_api_key_here 替换为你的密钥。

客户端	模型	配置
Claude Desktop	Claude	claude_desktop_config.json
Claude Code	Claude	claude mcp add 命令
Cursor	GPT、Claude、Gemini 等	~/.cursor/mcp.json
VS Code（GitHub Copilot）	GPT、Claude、Gemini	.vscode/mcp.json
Windsurf	GPT、Claude、Gemini 等	~/.codeium/windsurf/mcp_config.json
Codex CLI / IDE（OpenAI）	OpenAI GPT	~/.codex/config.toml
Gemini CLI	Google Gemini	~/.gemini/settings.json
Cline、Zed、Continue 等	任意	标准 mcpServers JSON

仅限浏览器的应用（chatgpt.com、claude.ai、gemini.google.com）无法运行本地 MCP 服务。请使用上述桌面应用、编辑器或终端应用。

Claude Desktop

编辑配置文件，或通过 设置 → 开发者 → 编辑配置 打开：

• macOS： ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows： %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "niceform": {
      "command": "npx",
      "args": ["-y", "niceform-mcp-server"],
      "env": {
        "NICEFORM_API_KEY": "nf_live_your_api_key_here"
      }
    }
  }
}

之后重启 Claude Desktop。

Claude Code

claude mcp add niceform --scope user -e NICEFORM_API_KEY=nf_live_your_api_key_here -- npx -y niceform-mcp-server

在 Claude Code 中运行 /mcp，确认已连接。

Cursor

将与 Claude Desktop 相同的 mcpServers JSON 添加到 ~/.cursor/mcp.json（适用于所有项目）或 .cursor/mcp.json（适用于单个项目）。它可与您在 Cursor 中选择的任意模型配合使用。

VS Code（GitHub Copilot）

在工作区中创建 .vscode/mcp.json。VS Code 使用 servers 键，而不是 mcpServers：

{
  "servers": {
    "niceform": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "niceform-mcp-server"],
      "env": {
        "NICEFORM_API_KEY": "nf_live_your_api_key_here"
      }
    }
  }
}

然后在 Agent 模式下使用 Copilot Chat。

Windsurf

将与 Claude Desktop 相同的 mcpServers JSON 添加到 ~/.codeium/windsurf/mcp_config.json，然后刷新 Cascade。

Codex（OpenAI）

添加到 ~/.codex/config.toml。Codex CLI 和 IDE 扩展都使用此文件。

[mcp_servers.niceform]
command = "npx"
args = ["-y", "niceform-mcp-server"]
env = { NICEFORM_API_KEY = "nf_live_your_api_key_here" }

Gemini CLI

将与 Claude Desktop 相同的 mcpServers JSON 合并到 ~/.gemini/settings.json（所有项目）或 .gemini/settings.json（单个项目）中。

其他 MCP 客户端

任何支持本地（stdio）服务的客户端都可以使用。大多数客户端都接受上述 mcpServers JSON。否则，请使用以下值：

设置	值
命令	npx
参数	-y niceform-mcp-server
Env	NICEFORM_API_KEY=nf_live_your_api_key_here

全局安装（可选）

如果你不想使用 npx：

npm install -g niceform-mcp-server

然后在上述任一配置中，将 niceform-mcp 用作命令，不带任何参数。

从源代码安装

git clone https://github.com/Shirish-Singh/niceform-mcp && cd niceform-mcp && npm install && npm run build

然后将客户端指向 node /absolute/path/to/niceform-mcp-server/dist/index.js。

可用工具

create_form

根据自然语言描述创建新表单。

参数：

• description（必填）：表单的自然语言描述
• idempotency_key（必填）：由调用方生成的唯一键，建议使用 UUID；重试同一创建请求时应重复使用
• style_preference（可选）：modern、minimal、colorful、professional 或 default 之一

示例：

Create a customer feedback form for a coffee shop with:
- Overall rating (1-5 stars)
- Service quality rating
- Coffee quality rating
- Free text comments
- Optional email for follow-up

get_preview_url

获取表单的预览 URL，以查看其外观。

参数：

• form_id（必填）：来自 create_form 的表单 ID

publish_form

发布表单，使其可公开访问。

参数：

• form_id（必填）：要发布的表单 ID
• name（可选）：覆盖表单名称

list_form_responses

检索你拥有的表单的提交内容。响应可能包含个人数据，因此只请求并公开用户任务所需的字段。

参数：

• form_id（必填）：表单 UUID 或公开 ID
• status（可选）：submitted、completed、incomplete 或 all；默认为 submitted
• limit（可选）：每页条数，整数，范围为 1 到 100；默认为 25
• cursor（可选）：上一页返回的不透明游标
• since（可选）：带时区偏移的 ISO 8601 时间戳；仅返回在此时间之后提交的响应。轮询时请重复使用返回的 latestSubmittedAt。

close_form

停止接收响应。参数：form_id（必填）。

list_forms

列出你拥有的表单。参数（均可选）：query（按名称筛选）、limit（每页条数）、cursor（来自上一页）。

get_form

获取表单的字段和状态。参数：form_id（必填）。

summarize_responses

汇总表单响应：总数、各字段答案数量、选项数量以及最小值/最大值/平均值。参数：form_id（必填）。

export_responses_csv

将表单响应导出为 CSV。参数：form_id（必填）；status（可选）：submitted、completed、incomplete 或 all；默认为 submitted。

示例工作流

You: Create a simple contact form with name, email, and message fields

Assistant: [Uses create_form tool]
           Form created! Preview URL: https://www.niceform.ai/forms/abc123

You: Looks good, publish it

Assistant: [Uses publish_form tool]
           Published! Share this URL: https://www.niceform.ai/forms/abc123

开发

# Watch mode (auto-rebuild on changes)
npm run mcp:dev

# Build once
npm run mcp:build

# Run the server directly
npm run mcp:start

故障排除

“未设置 NICEFORM_API_KEY”

确保已在客户端 MCP 配置的 env 块中设置 NICEFORM_API_KEY。密钥应以 nf_live_ 或 nf_test_ 开头。

“API 密钥无效”

你的 API 密钥可能已被撤销或过期。请从 niceform.ai 控制面板生成新密钥。

“超出速率限制”

你发送的请求过多。请等待错误消息中指明的重试时间。

客户端中未显示工具

1. 编辑配置后，重启客户端（或重新加载其 MCP 服务）
2. 检查配置文件语法。JSON 必须有效，且不能有尾随逗号。
3. 确保已安装 Node.js 18+，且 npx 位于 PATH 中。有些 GUI 应用不会继承 shell 的 PATH。如果你的应用没有继承，请使用 npx 的完整路径（使用 which npx 查找）。
4. VS Code：使用 servers 键，而不是 mcpServers

许可证

MIT

链接

• niceform.ai - AI 驱动的表单构建工具
• MCP 文档 - Model Context Protocol
• MCP 客户端 - 支持 MCP 的应用