CORE CONTRACTSPEC

Learn the common model.

These guides explain the foundation shared by the packages and capabilities across the system.

Début

Start with one shared behavior

3 min read

Choose a small operation, understand its boundaries, and decide what to adopt next.

Look inside the guideOpening context · complete reading path

Choose a behavior that already matters

Start with an action or query that more than one part of your product needs: submitting a request from a form, fetching the same account data through an API, or letting an agent request a reviewed export. A useful first operation has a clear input, an observable result and an existing owner.

Work through the guide
Début

Installation and release channels

3 min read

Match documentation to the code you actually consume, then verify a small external project.

Look inside the guideOpening context · complete reading path

Choose the code you are evaluating

There are two useful starting points: consuming published packages in your application, or studying a checked-out repository snapshot. Select one explicitly. Instructions for a monorepo can rely on workspace dependencies and repository scripts that a package consumer does not have.

Work through the guide
Début

Read your first operation

3 min read

Trace a maintained contract from its input schema to its deliberately small handler.

Look inside the guideOpening context · complete reading path

What this walkthrough demonstrates

The maintained minimal example declares an operation named user.create. It accepts an email and returns the same email. Despite the operation's name, the shown handler does not create a persistent account, send a message or call a provider.

Work through the guide
Début

Adopt ContractSpec in an existing codebase

3 min read

Wrap one behavior you already own, preserve its observable behavior, and expand from evidence.

Look inside the guideOpening context · complete reading path

Select a small adoption seam

Choose a function or endpoint that already has a clear owner and useful tests. Prefer a contained read or a reversible local action for your first exercise. A workflow that spans several providers, jobs and billing decisions makes it difficult to tell whether a problem comes from your application or the integration.

Work through the guide
Concepts

Contracts, handlers and adapters

3 min read

Understand the separate responsibilities that let one operation serve several interfaces.

Look inside the guideOpening context · complete reading path

The contract describes the behavior

An operation contract names a command or query and describes its data and requirements. The model includes metadata, input and output schemas, result definitions, policy, declared effects, transport hints and links to related presentations or tests.

Work through the guide
Concepts

What the runtime checks

3 min read

Follow a call from transport context to handler execution, then understand the limits of each guard.

Look inside the guideOpening context · complete reading path

Follow the execution boundary

A registered call resolves an operation and its bound handler, prepares the input and execution context, invokes the handler, and validates the returned value. The exact checks depend on the contract and the ports supplied by the host.

Work through the guide
Concepts

Authentication, policy and scoped approval

3 min read

Give each decision a clear owner and prove that denied requests never reach the protected handler.

Look inside the guideOpening context · complete reading path

Separate the decisions

Authentication establishes who is calling. Policy decides whether that subject may perform a particular operation in context. Scoped approval supplies evidence that a specific request or class of effects has been reviewed. A ceremony requirement can require additional, fresh verification at execution time.

Work through the guide
Concepts

Model inputs, outcomes and failures

3 min read

Make the data boundary explicit while keeping business meaning in the operation and handler.

Look inside the guideOpening context · complete reading path

Describe what the caller must supply

An input schema should express the shape you actually accept, including required values and constraints that can be checked before execution. Keep the distinction between an absent value and a valid empty value clear.

Work through the guide
Guides

Expose one operation through API and MCP

3 min read

Share the registered behavior while keeping authentication, transport formats and evidence explicit.

Look inside the guideOpening context · complete reading path

Start from one registry

Register the operation and bind its handler once. The REST createFetchHandler and MCP registerMcpTools implementations both call OperationSpecRegistry.executeResult. That shared invocation path is the useful connection between an API request and an agent tool call.

Work through the guide
Guides

Build interfaces around roles and intent

3 min read

Resolve appropriate surfaces for people and agents while keeping authority on the execution side.

Look inside the guideOpening context · complete reading path

Start with the task, actor and context

A reviewer, an operator and an agent may work on the same workflow while needing different information and actions. Model that difference explicitly instead of copying the entire workflow into unrelated screens.

Work through the guide
Guides

Compose features with explicit dependencies

3 min read

Connect capabilities, operations and provider ports without hiding what a feature needs to execute.

Look inside the guideOpening context · complete reading path

Treat a feature as a set of declared dependencies

A larger feature often combines operations, policy decisions, UI surfaces and external services. Feature Hubs provide a way to make those relationships inspectable rather than burying them in application startup code.

Work through the guide
Guides

Generation and drift: what changes, what does not

3 min read

Use derived artifacts deliberately and understand the current boundary of generation plans and apply.

Look inside the guideOpening context · complete reading path

Separate authored behavior from derived artifacts

Keep the contract and the business implementation distinct from files produced by tooling. Review the source that owns a change, then regenerate the affected output instead of patching a derived file as the permanent fix.

Work through the guide
Guides

Bind external services deliberately

3 min read

Keep a feature's requirements separate from credentials, tenant connections and provider behavior.

Look inside the guideOpening context · complete reading path

Separate requirement, connection and binding

An application can describe the capability it needs without embedding a provider account in its contract. The integration model distinguishes a service definition, a tenant's configured connection and the application binding that selects a connection for a named slot.

Work through the guide
Reference

Find the right reference

3 min read

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

Look inside the guideOpening context · complete reading path

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.

Work through the guide
Reference

Use the docs with coding agents

4 min read

Give an agent a small, versioned source set and keep documentation lookup separate from action authority.

Look inside the guideOpening context · complete reading path

Start with a focused context packet

Give the agent the task, selected package versions or source commit, the relevant guide, and the exact contract or runtime reference. A small coherent source set is easier to verify than the entire monorepo corpus.

Work through the guide
Operations

Test the promise at the boundary

3 min read

Choose checks that establish meaningful behavior, including denied effects and real consumer imports.

Look inside the guideOpening context · complete reading path

Give each test one question

An operation has several boundaries, and one green check cannot answer every question about them. Separate declaration validity, business behavior, adapter behavior and external consumption so failures tell you where to look.

Work through the guide
Operations

Version contracts and documentation together

3 min read

Keep operation identity, package releases and deployment revisions distinct when reviewing a change.

Look inside the guideOpening context · complete reading path

Know which version you mean

A contract's version identifies a particular declared behavior. A package version identifies a distribution artifact. A website or application revision identifies a deployment. Those numbers can change independently.

Work through the guide
Operations

Find the boundary that failed

3 min read

Diagnose package, schema, execution and transport failures without changing several layers at once.

Look inside the guideOpening context · complete reading path

Capture a small reproducible case

Record the package versions or commit, operation key and version, chosen adapter and sanitized request. Keep the first relevant error and trace identifier. Start from the boundary where the failure appears instead of reinstalling or regenerating the entire project.

Work through the guide
Operations

Contribute a reviewable change

3 min read

Change the owning source, update the public explanation and bring evidence for the behavior you touched.

Look inside the guideOpening context · complete reading path

Read the instructions for the selected checkout

Begin with the repository's AGENTS.md and the instructions in the owning package. The integration branch is actively changing, so locate the current owner rather than relying on a historical directory map.

Work through the guide
Operations

Observe a call without confusing it with approval

3 min read

Use traces and outcomes to diagnose execution, and keep durable evidence requirements explicit.

Look inside the guideOpening context · complete reading path

Carry context through the call

A useful operation trace lets you connect a request, its selected contract version, the handler outcome and the interface that invoked it. The registry's canonical result can carry trace and source context supplied by the host.

Work through the guide
Votre vue

Make room for your context.

Shape the presentation around this moment. You can change it whenever you need.

Votre contexte

The different parts of you

Choose a starting point

Un mélange utile de contexte, de visuels et de guidage discret.

Tune each dimension
Each dimension can change independently. Product permissions and available actions stay unchanged.

Support the way you begin and return

Tune your support

Confort de lecture

Choisir votre langue

La langue de l’interface change uniquement le texte. Les marchés, les prix et les parcours conservent leurs propres paramètres.

Couverture des traductions

Une partie du contenu est affichée en anglais.

Navigation151
Graphe616
Catégories378
Portfolio833
Exemples2 035
Aperçu de la source1 542

D’autres traductions seront ajoutées à mesure que le contenu sera relu.

Cette préférence est enregistrée dans ce navigateur.

Rechercher sur le site

Des points de départ utiles

Aucun résultat. Essayez une expression plus courte, un nom d’opération ou un autre périmètre de recherche.

UN PEU DE PLACE POUR EXPLORER

Trouvez quelque chose à explorer.

Ouvrez un aperçu détaillé sur cette page, essayez une autre perspective ou suivez le détail vers sa propre page.

Fonctionnement des aperçus et des commandes
01

Regarder avant de partir

Survolez un lien ou sélectionnez-le avec Tab pour voir un aperçu. Cliquer sur le lien d’origine ou appuyer sur Entrée ouvre toujours sa destination.

02

Rester dans le contexte

Entrez dans l’aperçu pour explorer ses sections. Depuis un lien sélectionné, utilisez Alt + ↓ pour y entrer au clavier. Échap le ferme.

03

Ouvrir les possibilités

Les lignes dépliables, les choix de perspective et les commandes mises en évidence révèlent davantage. Votre vue adapte le confort de lecture et le contexte exploré.

Un bouton séparé pour voir de plus près

Affichez de petits boutons d’aperçu à côté des liens quand l’espace le permet. Touchez l’œil pour examiner ou le lien pour y aller directement. Ce choix reste dans cet onglet.

Aucun historique de navigation n’est collecté. La réduction des animations suit votre appareil et Votre vue.