Choose an integration surface - Shodai Developer Documentation

Choose the first-run path that matches who will drive the workflow.

Surface	Use it when	First success	Start here
TypeScript SDK	You are building a TypeScript application or service.	Authenticate, validate an example agreement, preflight deployment, and sign a deploy permit locally without deploying.	Quickstart with TypeScript SDK
MCP	You are connecting an AI agent or MCP-capable tool client.	Connect hosted MCP, call authenticated tools, validate an example agreement, and prepare deploy typed data.	Quickstart with MCP

Your integration surface and credential are separate choices. Use an API key when the integration manages a credential for one account. Use delegated OAuth when an application asks a user to connect their Shodai account without sharing an API key.

What happens after quickstart

Both paths converge at the same agreement lifecycle. After one quickstart succeeds, run Run an end-to-end agreement workflow to deploy an agreement, submit a signed lifecycle input, read state, and inspect input history.

Where the TypeScript client reference fits

Use TypeScript client reference after first setup when you need constructor options, method details, signing helpers, diagnostics, path helpers, or exports. MCP users who do not already have signing infrastructure can also use the TypeScript SDK with viem as the local testnet signing harness for EIP-712 typed data returned by hosted MCP.

⌘I