SurveyJS AI Agent Skills

SurveyJS AI Agent Skills are instructions and reference files that help your agent create survey JSON, add a form to an app, change its appearance, and perform other SurveyJS tasks. After you install them, your agent can select a skill based on what you ask it to do.

Choose project installation to share the skills with your team. To set up your own agent, follow the installation instructions.

To share the skills with everyone working on your project, install them in the project folder. Node.js 22 or later is required. Open a terminal in that folder and run:

npx surveyjs-cli@latest init-agents

The command checks which SurveyJS packages your project uses and asks you to choose your AI coding tools. It then installs the matching skills and records the package versions it finds. If it finds no SurveyJS packages, it installs all skills.

You can also select your AI coding tools with the --client option. For example, to install skills for Claude Code and Cursor, run:

npx surveyjs-cli@latest init-agents --client=claude,cursor

Add --dry-run to either command to preview the files it will create or update.

Use the following values with --client. The CLI saves skills in the corresponding folder within your project:

For Copilot and AGENTS.md clients, the CLI also adds a SurveyJS section to the project's instructions file.

Once installation is complete, commit the generated files, including .surveyjs-skills.json, which tracks the installation. This lets your teammates' agents use the same instructions.

To install skills for your own agent, add the SurveyJS plugin or copy the skill files into the folder your agent reads. Follow the instructions for your agent:

• OpenAI Codex
• Claude Code
• Google Gemini CLI
• GitHub Copilot CLI
• xAI Grok Build
• Other agents

After installation, describe the change you want. The agent can choose the relevant skill automatically, or you can name a skill in your prompt:

Use surveyjs-form-json to add an employment details page that appears when the respondent selects "Employed". Use surveyjs-linter to check the updated definition.

Tell the agent which framework your project uses and give it access to the files you want to change. Review and test its changes in your application.

Use this table to find a skill for your task:

The skills for integrating and styling SurveyJS components use v3 APIs. If your project uses an older version, include that version in your prompt so that the agent can check whether the suggested APIs are available.

When you change the SurveyJS packages in your project, run the following command to refresh the installed skills:

npx surveyjs-cli@latest update

The command uses .surveyjs-skills.json to refresh skills for the same AI coding tools. It also installs the skills included in the latest CLI release. To check whether an update is needed before making changes, run:

npx surveyjs-cli@latest doctor

If you installed a plugin instead, update it through your agent. If you copied the skill folders manually, replace them with the latest copies from the surveyjs-skills repository.

For more command options, see the CLI documentation on GitHub.

Skills guide the agent through a task. To let it look up documentation while it works, connect the SurveyJS MCP server. If you have a particular guide or example in mind, include its Markdown URL in your prompt.