Skip to content
ContractSpec
Start here

Core guide · Reference · 3 min read

Find the right reference

Navigate portable models, runtime execution, adapters and generated contract records by responsibility.

Source context

Source-guided · d58fa5b7

Repository links may require access. Source inspection is separate from a clean public-package installation.

AN INTERACTIVE READING MAP

Get the shape of this guide.

Move through the ideas, inspect their relationships, or make a focused reading path. The complete guide stays below.

READING SEQUENCE

Understand how the ideas connect

01 / READING POINT

Choose the reference that answers your question

Guides explain how to accomplish a task; reference records explain a particular surface. Start with the layer that owns your question so a package catalogue does not become your learning path.

The inspected generated manifest contains 1,300 records. The public explorer shows eligible public reference metadata; internal, mixed or unspecified records stay out of its default results. Reference records describe source surfaces, not independently verified tutorials.

1 / 4

0 points in your packet

Choose the reference that answers your question

Guides explain how to accomplish a task; reference records explain a particular surface. Start with the layer that owns your question so a package catalogue does not become your learning path.

The inspected generated manifest contains 1,300 records. The public explorer shows eligible public reference metadata; internal, mixed or unspecified records stay out of its default results. Reference records describe source surfaces, not independently verified tutorials.

QuestionOwner to inspectUseful source
What does an operation declare?Portable contractscontracts-spec operation model
What runs before a handler?Runtime kerneloperations/prepare and registry
How does HTTP or MCP expose a call?Delivery adapterREST handler or MCP registration
How are role surfaces selected?Surface runtimeRoleMorph resolver
What does this specific contract contain?Generated referenceKey, version and declaration source
Where is a public import supported?Package export mapThe selected version's package.json

Read a reference record

Use the contract key as its identity, then inspect the version, kind, ownership and stability where available. Follow the declaration source for the full model and the relevant handler or runtime for execution behavior.

A stability field describes the contract's declared status. It does not establish that an integration was exercised against a live provider or that a package has been installed outside the monorepo.

Understand generated lineage

The existing docs loader reads a manifest, loads metadata chunks and resolves each record's Markdown content from the generated docs tree. Update the owning declaration or DocBlock, then regenerate; do not make permanent edits to the generated JSON.

The inspected manifest uses a deterministic generatedAt value and has no release version. Treat that as a reproducibility mechanism with missing release provenance, not as a meaningful freshness date.

Give an agent a coherent slice of the system.

An agent is asked to change one operation. A useful context packet keeps the task, source identity and execution responsibilities together.

What does the agent need to do?

A CONCRETE SITUATION

Start with orientation and a bounded reference.

The task names a capability but not the package that owns it.

01 / Orient

Read the relevant area and task context.

What changes

An area overview and package overview narrow the source set.

What stays explicit

A package listing does not establish registry availability or permission to edit it.

Follow the consequence

Choose the relevant package and source identity, then follow the exact manual or structured source data.

Use the docs with coding agents ↗

An authored situation, grounded in the linked source guides. Choosing a case explores its expected responsibilities; it does not execute an operation.