wjx-ai-kit

问卷星 AI 工具套件 — SDK、MCP Server、CLI 三位一体，让 AI Agent 和开发者无缝操控问卷星 OpenAPI。

项目结构

本仓库采用 npm workspaces 管理三个包：

wjx-ai-kit/
├── wjx-api-sdk/       # 零依赖 TypeScript SDK（50+ API 函数）
├── wjx-mcp-server/    # MCP Server（58 Tools / 8 Resources / 22 Prompts）
├── wjx-cli/           # 命令行工具（AI Agent 原生 CLI）
├── wjx-agents/        # 2 个专家 Agent 定义
├── wjx-skills/        # 2 套 Skill 参考文档（可打包分发 zip）
├── wjx-docs/          # 使用文档 + AI 工具配置指南
└── package.json       # workspace 根配置

⚡ 在 Claude Code 一键装 Skill（推荐）

wjx-ai-kit 本身就是一个 Claude Code Plugin Marketplace。在 Claude Code 里执行：

/plugin marketplace add wjxcom/wjx-ai-kit
/plugin install wjx-cli-use@wjx-ai-kit

之后跟 Claude 说"帮我做一份满意度问卷"、"分析下这组 NPS 评分"、"导出问卷 12345 的答卷"——它会自动调用 wjx-cli 完成。后续 SKILL 更新时执行 /plugin marketplace update 即可拉到最新版。

如果你的客户端原生支持 MCP 协议（Claude Code/Desktop、Cursor、Cline），也可以装 MCP 版（次要选项）：

/plugin install wjx-mcp-use@wjx-ai-kit

AI 工具配置指南

在你的 AI 工具中接入问卷星，用自然语言创建问卷、分析数据、管理通讯录。

架构关系

┌─────────────────────────────────────────────┐
│              AI 客户端 / 脚本                 │
├──────────┬──────────────┬───────────────────┤
│ wjx-cli  │ wjx-mcp-server │  你的 Node.js 项目  │
│  (CLI)   │  (MCP Server)  │                   │
├──────────┴──────────────┴───────────────────┤
│              wjx-api-sdk                     │
│         （统一 API 客户端层）                  │
├─────────────────────────────────────────────┤
│           问卷星 OpenAPI                      │
└─────────────────────────────────────────────┘

wjx-api-sdk 是基础层，wjx-mcp-server 和 wjx-cli 都依赖它。

快速开始

前置条件

• Node.js >= 20
• 问卷星 OpenAPI API Key — 微信扫码登录 API Key 获取页，登录后页面直接显示 API Key

安装

从 npm 安装（推荐）

# SDK — 在你的 Node.js 项目中使用
npm install wjx-api-sdk

# CLI — 全局安装命令行工具
npm install -g wjx-cli

从源码安装（开发者）

git clone https://github.com/wjxcom/wjx-ai-kit.git
cd wjx-ai-kit
npm install

使用方式一：CLI（推荐）

适合脚本、CI/CD、AI Agent 工具调用，几乎所有 AI 客户端通用（不需要 MCP 协议）。

# 全局安装
npm install -g wjx-cli

# 使用
export WJX_API_KEY=your_api_key
wjx survey list
wjx response query --vid 12345

详见 wjx-cli/README.md。

使用方式二：SDK（编程集成）

适合在你自己的 Node.js 项目中调用问卷星 API。

npm install wjx-api-sdk

import { listSurveys, createSurvey } from "wjx-api-sdk";

const creds = { apiKey: "your_api_key" };

// 列出问卷
const surveys = await listSurveys({ page_index: 1, page_size: 10 }, creds);

// 创建问卷
const result = await createSurvey({
  title: "客户满意度调查",
  type: 0,
  questions: "[]",
}, creds);

详见 wjx-api-sdk/README.md。

使用方式三：MCP Server（可选 · 从 GitHub 源码安装）

仅适用于原生支持 MCP 协议的客户端（Claude Code/Desktop、Cursor、Cline 等）。功能与 CLI 等价；如果你的客户端能跑 shell，优先选 CLI——升级、维护、跨平台都更省心。

⚠️ wjx-mcp-server 已退出 npm 主发版节奏。npm 上的 [email protected] 不会再推送新版本。需要最新功能/修复请按下面步骤从 GitHub 源码安装。

# 1. 从 GitHub 克隆并构建
git clone https://github.com/wjxcom/wjx-ai-kit.git
cd wjx-ai-kit
npm install
npm run build --workspace=wjx-api-sdk
npm run build --workspace=wjx-mcp-server

# 2. 配置环境变量
echo "WJX_API_KEY=your_api_key" > wjx-mcp-server/.env

# 3. 启动（stdio 模式）
npm start --workspace=wjx-mcp-server

# 后续更新：拉新代码并重新 build，然后完全重启你的 AI 客户端
git pull && npm run build --workspace=wjx-mcp-server

完整的 AI 客户端 MCP 配置（Claude Desktop / Cursor / Cline 等）见 wjx-mcp-server/README.md，或查看上方 AI 工具配置指南。

文档

完整的使用文档和指南位于 wjx-docs/ 目录：

开发

# 安装所有 workspace 依赖
npm install

# 构建所有包（SDK 必须先构建）
npm run build --workspace=wjx-api-sdk
npm run build --workspace=wjx-mcp-server
npm run build --workspace=wjx-cli

# 运行所有测试
npm test --workspace=wjx-api-sdk      # ~623 tests
npm test --workspace=wjx-mcp-server   # ~280 tests
npm test --workspace=wjx-cli          # ~133 tests

环境变量

贡献

欢迎贡献！请参阅 CONTRIBUTING.md 了解贡献指南。

许可证

MIT