Resources

Resources are read-only reference documents addressed by a cycle:// URI. The agent reads them to learn syntax, conventions, the step catalog, and the lay of the land. You can ask the agent to read any of them for you.

The full, current set is always discoverable from the master index, cycle://toc. The agent reads that first to see everything the server offers. New reference documents are added over time, so treat the lists below as the important highlights rather than an exhaustive inventory.

Every resource requires a signed-in Cycle session. See Signing in to Cycle.

Catalogs and indexes

Resource URI	What is in it
cycle://toc	The master table of contents: an index of every resource the server exposes. The agent reads this first to discover what is available.
cycle://categories	A JSON list of every step category name (Web, File Action, Comparison, and so on). Read before cycle://steps/{category} so the category name is valid rather than guessed.
cycle://prompts	A catalog of the guided Prompts the server provides, and the fields each one asks you to fill in.
cycle://subagents	A catalog of the specialized Agents the main agent can delegate to, with each one's input and output contract.
cycle://context	An index of the served context documents, both the general ones and the Blue Yonder ones when those are enabled.

Step discovery

Resource URI	What is in it
cycle://steps	A compact index of every step rendered as `StepID` - step text, grouped by category. This is the step-discovery entry point: the agent reads the whole surface, reasons about which step fits, then drills in.
cycle://steps/{category}	All steps in one category. For example, cycle://steps/Web returns every web step.
cycle://step/{id}	The full definition of one step as JSON: parameter names, accepted values, required state, output variables, and usage examples. The agent reads this to get exact parameter names before generating a step line or calling the run_step tool.

Workflow and CLI references

These documents live under the cycle://context/core/ prefix.

Resource URI	What is in it
cycle://context/core/test-lifecycle	An end-to-end overview of how to create, execute, and debug Cycle tests. A section index: read it first, then fetch the section you need.
cycle://context/core/test-lifecycle/create	Starting a new Feature File, including when to hand authoring to a subagent.
cycle://context/core/test-lifecycle/execute	Running a test through cycle-cli or the run_test tool.
cycle://context/core/test-lifecycle/debug	The diagnostic workflow for a test that exited non-zero.
cycle://context/core/cli-reference	A reference for running tests with cycle-cli. Also a section index.
cycle://context/core/cli-reference/file-types	The file extensions cycle-cli accepts and how to mix them.
cycle://context/core/cli-reference/flags	The full flag reference, with syntax and accepted values.
cycle://context/core/cli-reference/examples	Recipe-style combined invocations for continuous integration, debugging, and tagged runs.
cycle://context/core/environment-variables	The environment variables that affect a cycle-cli run, such as proxy and verbosity settings.
cycle://context/core/project-layout	How a Cycle project directory is organized.

Blueprint authoring

These four resources are what the agent reads before writing or running a Blueprint. The schema resource is the authority on field names and semantics, so a well-behaved agent reads it rather than recalling the format from memory.

Resource URI	What is in it
cycle://blueprints/setup	First-run orientation: what a Blueprint and a blueprint library are, and the blueprint.libraryDir project setting every library-backed operation depends on. Read this first.
cycle://blueprints/authoring	The full guide to the author, validate, run, and teardown loop, including the catalog format, the system-first library layout, how a system configuration declares its capabilities, and how to smoke-test with no live system.
cycle://blueprints/schema	The authoritative field vocabulary: the action, source, and op tagged unions, create/find/ensure semantics, placeholder resolution, output-variable naming, and current engine limitations.
cycle://blueprints/examples	Worked, runnable example Blueprints to copy and adapt, covering SQL, MOCA, REST, and the self-contained flat-file case.

Run inspection and agent definitions

Resource URI	What is in it
cycle://run-errors/{output_dir}	Structured failure details for a finished run: the failing step, the error message, the stack trace, and a listing of all artifacts. {output_dir} is the results directory returned by run_test. The agent reads this on any failure before suggesting a fix.
cycle://subagents/{name}	The full definition of one specialized subagent, for example cycle://subagents/feature-file-author. The agent reads this before delegating work to that subagent.

No standalone authoring guide

You will not find a cycle://authoring-guide, cycle://language-spec, or cycle://locator-formats resource. The CycleScript authoring rules, the language grammar, and the locator formats are deliberately composed into the feature-file-author subagent definition, and served only at cycle://subagents/feature-file-author. That keeps a large body of authoring detail out of the main agent's context until the moment it is needed.