Help › Guide

Coding agents

Reqlyn 0.5.1 is not released yet. This help describes it ahead of release.

A coding agent (Claude Code, Codex, Cursor, OpenCode) can author a Reqlyn workspace: add requests, build operations from them, test an operation and keep the test as a regression case, then replay the cases. It does so through reqlyn mcp, Reqlyn's authoring MCP server on standard input and output, and the command line in JSON mode (The command line).

A folder workspace

Point the agent at a folder workspace: reqlyn mcp --folder ., started in the folder. Its requests, operations and cases are the folder's files, so each change the agent makes is a file change you review as a diff in Git before you commit it. Reqlyn's index and runs for the folder are kept in .reqlyn/ inside it, which Git ignores; the desktop's own workspace is not touched. Each change is saved at once. A request or variable that would hold a secret is refused: the agent names a credential or a secret variable, and you set its value. An operation that writes is not tested from the agent.

Installing

Reqlyn's repository has the skill and the configurations in integrations/agents/. Each needs reqlyn on the path.

  • Claude Code: the folder is a plugin and its own marketplace. /plugin marketplace add <path to integrations/agents>, then /plugin install reqlyn@reqlyn. It brings the reqlyn skill and the MCP server over the folder Claude Code is started in.
  • Codex: add codex/config.toml to ~/.codex/config.toml, and copy codex/AGENTS.md into the workspace as its AGENTS.md.
  • Cursor: copy cursor/mcp.json to the workspace's .cursor/mcp.json and cursor/reqlyn.mdc into .cursor/rules/.
  • OpenCode: copy opencode/opencode.json into the workspace, with codex/AGENTS.md as its AGENTS.md.

What the agent can do

The tools are the desktop assistant's (The assistant), saving at once: list and read requests, operations and variables (secrets masked or left out); add a request, a variable that is not a secret, an operation with its steps, inputs and outputs; change an output; test an operation that only reads, keep the test as a case, and replay the cases (test_cases). On a server, an agent with an editor's token authors drafts through the server's MCP endpoint instead (MCP tools).

deploy/agents/gate.sh, in Reqlyn's repository, shows it: it gives Claude Code the plugin in a fresh folder workspace, asks it to add a request and an operation, test it, keep the test as a case and replay the cases, then checks the folder, Git and the case on its own.

Help for Reqlyn 0.5.1. All help topics