# Seam

> 

- Documentation: https://pr-1-ff84656b4b8a.thally.app
- GitHub: https://github.com/thallylabs/seamdoc
- Full docs for LLMs: https://pr-1-ff84656b4b8a.thally.app/llms-full.txt
- Agent discovery (ai.txt): https://pr-1-ff84656b4b8a.thally.app/ai.txt
- Structured docs index (JSON): https://pr-1-ff84656b4b8a.thally.app/api/docs-index
- OpenAPI spec: https://pr-1-ff84656b4b8a.thally.app/openapi.yaml

## For AI agents

Every page supports content negotiation on its human URL:
- JSON API: append `?format=json` or send `Accept: application/json`
- JSON-LD: append `?format=ldjson` or send `Accept: application/ld+json`
- Markdown: append `?format=md` or send `Accept: text/markdown`
- Per-page API: https://pr-1-ff84656b4b8a.thally.app/api/docs/{page-id}
- Search API: https://pr-1-ff84656b4b8a.thally.app/api/search?q={query}
- Capability manifest (skill): https://pr-1-ff84656b4b8a.thally.app/skill.md
- Agent guidance (editing these docs): https://pr-1-ff84656b4b8a.thally.app/AGENTS.md
- MCP server (attach docs as native tools): https://pr-1-ff84656b4b8a.thally.app/api/mcp
- Agent readiness: https://pr-1-ff84656b4b8a.thally.app/api/agent-readiness

### Recommended workflow

1. Use this index, the search API, or `search_docs` before choosing a page.
2. Read the smallest set of relevant pages and follow their prerequisite links.
3. Treat the published docs as the source of truth. Label inferences and say when evidence is missing.
4. Cite the canonical human page URLs, not only API endpoints.
5. Use `/AGENTS.md` before editing a repository. The public MCP server is read-only.

## Get Started

### Overview

- [Introduction](https://pr-1-ff84656b4b8a.thally.app/): Seamline guards the seams between your services — API contracts with Specdiff and environment configuration with Envlock.
- [Quickstart](https://pr-1-ff84656b4b8a.thally.app/quickstart): Install Specdiff and Envlock, run each tool, and verify the result in under five minutes.

## Specdiff

### Overview

- [Specdiff Overview](https://pr-1-ff84656b4b8a.thally.app/specdiff/overview): Detect breaking changes between two versions of a JSON Schema or OpenAPI document with Specdiff.

### Usage

- [Specdiff CLI](https://pr-1-ff84656b4b8a.thally.app/specdiff/cli): Complete reference for the specdiff command-line tool for detecting breaking changes in JSON Schema and OpenAPI documents.
- [Core Library API](https://pr-1-ff84656b4b8a.thally.app/specdiff/core-api): Complete API reference for the @specdiff/core package — diffing functions, rule helpers, formatters, pointer utilities, ref resolution, types, and constants.
- [Rule Catalogue](https://pr-1-ff84656b4b8a.thally.app/specdiff/rules): Complete catalogue of all 45 Specdiff rules — JSON Schema rules, OpenAPI-only rules, direction-dependent severity, and how to configure overrides.

### Integrations

- [CI Integration](https://pr-1-ff84656b4b8a.thally.app/specdiff/ci-integration): Catch breaking API changes automatically in CI/CD pipelines with Specdiff.
- [Specdiff MCP Server](https://pr-1-ff84656b4b8a.thally.app/specdiff/mcp): Expose Specdiff as tools for AI assistants through the Model Context Protocol.

## Envlock

### Overview

- [Envlock Overview](https://pr-1-ff84656b4b8a.thally.app/envlock/overview): Typed environment variable contracts for TypeScript. Define schemas, validate at startup, generate .env.example files, and diff actual env against the contract.

### Usage

- [Defining Schemas](https://pr-1-ff84656b4b8a.thally.app/envlock/defining-schemas): Declare typed environment variable contracts with defineEnv, field builders, chain methods, and type utilities.
- [Validation and Parsing](https://pr-1-ff84656b4b8a.thally.app/envlock/validation): Complete reference for validation functions, error types, and projection utilities in @envlock/core.
- [Envlock CLI](https://pr-1-ff84656b4b8a.thally.app/envlock/cli): Complete reference for the envlock command-line tool, including all commands, flags, output formats, and exit codes.

### Integrations

- [Dotenv Support](https://pr-1-ff84656b4b8a.thally.app/envlock/dotenv): Parse and format .env files with parseDotenv and formatDotenv from @envlock/core. Full support for quoting, escaping, multiline values, comments, and round-trip fidelity.
- [Envlock MCP Server](https://pr-1-ff84656b4b8a.thally.app/envlock/mcp): An MCP server that exposes Envlock tools to AI assistants. Inspect contracts, validate environments, render .env.example files, diff env files, and explain issues.