Commands
Agent setup
Install the SignatureAPI agent skills and register the SignatureAPI MCP server in your coding agents from the CLI.
agent setup installs the SignatureAPI agent skills and registers the MCP server in the coding agents you choose. It is optional: the CLI’s other commands work without it.
agent setup
npx signatureapi agent setup
In a terminal, it asks which components to install and which agents to configure. To skip the prompts, name them:
npx signatureapi agent setup --skills --mcp --agent claude-code --yes
| Option | Description |
|---|---|
--skills | Install the SignatureAPI agent skills. |
--mcp | Register the SignatureAPI MCP server. |
--agent <name> | Agent to configure. Repeatable. |
--global | Install for your user instead of this project. |
--yes | Apply without the confirmation prompt. |
--status | Show what SignatureAPI has installed for each agent, at project and user scope. Installs and changes nothing. |
--json | Print the result as one JSON object. |
In a non-interactive shell, choose at least one component and at least one --agent.
Examples:
# Show what is already installed, without changing anything
npx signatureapi agent setup --status
# Choose components and agents interactively
npx signatureapi agent setup
# Install both into Claude Code for this project
npx signatureapi agent setup --skills --mcp --agent claude-code --yes
# Register the MCP server for your user in two agents
npx signatureapi agent setup --mcp --agent cursor --agent codex --global --yes
Supported agents
signatureapi agent setup --help lists the agents the installed version supports, with what setup can do for each. At the time of writing:
--agent | Agent | Notes |
|---|---|---|
claude-code | Claude Code | Plugin available. |
cursor | Cursor | |
codex | Codex | Plugin available. |
opencode | OpenCode | |
gemini-cli | Gemini CLI | |
github-copilot | GitHub Copilot CLI | |
windsurf | Windsurf | MCP at user scope only; use --global. |
kiro | Kiro CLI | |
zed | Zed | |
goose | Goose | MCP at user scope only; use --global. |
cline | Cline | MCP at user scope only; use --global. |
Project and user scope
Setup installs into the current project by default. --global installs for your user, so every project on the machine gets it.
Windsurf, Goose, and Cline read MCP servers from a user file only, so registering the MCP server for them needs --global.
What setup changes
- Skills. Setup installs every skill the public
signatureapi/skillsrepository publishes. An agent missing any of them gets all of them reinstalled at the current version. An agent that already has every skill is left unchanged. To refresh existing skills, remove their directories and run setup again. - MCP server. Setup registers the server at
https://mcp.signatureapi.com/mcpand keeps the rest of the agent’s MCP configuration. When the agent already has a different server namedsignatureapi, setup rejects the change instead of overwriting it. - Plugins. Claude Code and Codex can take the SignatureAPI plugin, which carries the skills and the MCP server together. Claude Code takes it at either scope. Installing the Codex plugin needs
--globaland both components; setup recognizes a Codex plugin you already installed at either scope.
Setup does not sign in to the MCP server, activate tools in a running session, or approve future tool calls. Follow its next steps: reload the agent, then sign in to the MCP server when the agent asks. See Connecting clients.
Check what is installed
npx signatureapi agent setup --status
For each agent, --status shows whether it is installed on this machine, whether the SignatureAPI plugin is installed, and whether the MCP server and skills are configured at project and user scope. Agents are marked ✔ set up, • needs setup, or – not detected. It changes nothing, and suggests the setup command only for detected agents that are missing SignatureAPI.
Add --agent to check specific agents, and --json for one JSON object.
During init
After init saves the API key in a terminal, it checks which supported agents are installed and offers to set up the ones that don’t have SignatureAPI yet:
- One agent: a yes or no question.
- Several agents: a checklist with every agent selected. Space toggles an agent, Enter confirms, and Esc skips.
An agent counts as installed when its command is on your PATH, or when a configuration directory only it uses exists. Agents that read MCP servers from a user file only are set up for your user, and the rest for the project.
Without a terminal, with --json, or when a coding agent runs init, nothing is asked or installed. The result’s next steps give the exact agent setup command instead. --no-agent-setup skips the check.
To set up agents during init without the prompt, pass the components and agents:
npx signatureapi init --skills --mcp --agent claude-code --yes
Agent setup runs after the key is saved. If setup fails, the key stays saved and the result is agent_setup_failed.
JSON output
agent setup --json prints a JSON object, not the event stream other commands print. The object reports the scope, each component’s status per agent, and next steps. The exit code is 0 when every component is configured, and 1 when any of them failed.
When the command cannot run, it prints {"status":"failed","code":"...","message":"..."} instead:
| Code | Exit code | Meaning |
|---|---|---|
invalid_selection | 2 | An unsupported agent, no component, or --status combined with install options. |
missing_selection | 2 | No component or no agent was chosen in a non-interactive shell. |
cancelled | 2 | You canceled the prompt. Nothing changed. |
setup_failed | 1 | The command could not be completed. |