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 SEQUENCEUnderstand how the ideas connect
Choose a point to look closer ↓
01 / Guide section
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.
Read the supporting context +
This is a reading walkthrough of real source. It helps you understand the shape of an operation before introducing databases, authentication or transport setup. The complete files are linked from the source snapshot; the excerpts below are intentionally partial.
Explore a section, then continue with the complete article below.
1 / 5
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.
This is a reading walkthrough of real source. It helps you understand the shape of an operation before introducing databases, authentication or transport setup. The complete files are linked from the source snapshot; the excerpts below are intentionally partial.
Read its identity first
The meta object gives the operation a stable key and version, then records its purpose, ownership and stability. These fields tell a caller which contract it is using and help a maintainer find the responsible team.
Use the key and version together when comparing an implementation with its documentation. A source path can move without changing the operation's public identity.
typescript
key: 'user.create',
version: '1.0.0',
Exact metadata excerpt from examples/minimal/src/contracts/user.ts at d58fa5b7; not a standalone declaration.
↳Change the entry point. Keep the meaning.Trace the mechanism · 3 ways to look closer+
Follow a request to export a report through three interfaces. The useful common ground is the registered operation and its boundary.
Where does this request begin?
A CONCRETE SITUATION
A form helps someone make a valid request.
A person selects a report and gives a reason for the export.
01 / Form
Collect the report and reason, and explain errors in the person’s language.
What changes
Labels, validation messages and the way the result is presented.
What stays explicit
The report, required reason, business implementation and configured execution checks.
FOLLOW THE CONSEQUENCE
The form can make a requirement clear. The server still needs to reject a request that bypasses the form.
UserInput is a SchemaModel with one required email field. The maintained declaration uses ScalarTypeEnum.EmailAddress(). Both input and output point to that model, so the example describes the same shape on either side.
Its authentication setting is anonymous because the example is demonstrating data flow. Treat that as an intentional property of this sample, not a default to copy into an operation that reads or changes private data.
Exact partial contract excerpt from examples/minimal/src/contracts/user.ts at d58fa5b7.
Find the business implementation
The companion userInputHandler has a type derived from CreateUser and returns the provided email. The contract describes the boundary; this function supplies the implementation. Editing the declaration does not magically add persistence to this function.
To turn the example into a real account workflow, you would need to decide how accounts are stored, what happens when an address is already used, how identity is established and which outcome the caller receives. Those choices belong to your application.
typescript
return {
email: input.email,
};
Exact handler excerpt from examples/minimal/src/handlers/user-input.handler.ts at d58fa5b7.
Make the next experiment observable
First inspect the example's typecheck, validation and smoke scripts. Its smoke test checks stable example metadata and the feature-to-operation reference; it is not an end-to-end API test.
For your own next step, bind a disposable handler to the registry and test a valid email, invalid input and an invalid handler result. Then expose that registry through one adapter. This adds one responsibility at a time and makes failures easy to locate.
See it in an example.
Contracts / Beginner
Write your first contract
Define an operation
Follow user.create from an email schema to a typed handler. Start with the smallest maintained example.
01
Describe the input
02
Name the operation
03
Follow the handler
Source demonstratesThe maintained source declares user.create with a required email input and a typed output.
Does not demonstrateA database account is created or an email is sent.
Inspect the walkthroughBehavior · proof and limits · source checks+
Follow the source behavior
A small user.create command accepts one required email address. Its current handler returns the same email. This gives you a compact place to understand the contract and handler boundary before adding storage or authentication.
Describe the input
Read UserInput in src/contracts/user.ts. The schema has one required EmailAddress field. The command uses the schema for both input and output.
Name the operation
Inspect the user.create key, version 1.0.0, owner, goal, and anonymous authentication policy. These describe the operation and its boundary.
Follow the handler
Open src/handlers/user-input.handler.ts. HandlerForOperationSpec derives the handler shape from CreateUser. The implementation returns input.email; it does not create a persisted account.
Inspect and adapt the starter
Read the package smoke fixture and validation script. Replace the echo handler with your own behavior, then test that behavior and the contract boundary together.
What this example establishes+
Source demonstrates
The maintained source declares user.create with a required email input and a typed output.
The handler is typed from the operation specification.
A source smoke fixture checks starter metadata and feature registration.
Does not demonstrate
A database account is created or an email is sent.
This example exposes an MCP tool: its manifest disables MCP.
This starter implements an approval gate, persistence, or production authentication.
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.
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.
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.