# Seamly

> 

- Documentation: https://pr-1-ee19382a0710.thally.app
- GitHub: https://github.com/thallylabs/seamlydocs
- Full docs for LLMs: https://pr-1-ee19382a0710.thally.app/llms-full.txt
- Agent discovery (ai.txt): https://pr-1-ee19382a0710.thally.app/ai.txt
- Structured docs index (JSON): https://pr-1-ee19382a0710.thally.app/api/docs-index
- OpenAPI spec: https://pr-1-ee19382a0710.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-ee19382a0710.thally.app/api/docs/{page-id}
- Search API: https://pr-1-ee19382a0710.thally.app/api/search?q={query}
- Capability manifest (skill): https://pr-1-ee19382a0710.thally.app/skill.md
- Agent guidance (editing these docs): https://pr-1-ee19382a0710.thally.app/AGENTS.md
- MCP server (attach docs as native tools): https://pr-1-ee19382a0710.thally.app/api/mcp
- Agent readiness: https://pr-1-ee19382a0710.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

### Get started

- [Seamline](https://pr-1-ee19382a0710.thally.app/): Catch API breaking changes before they ship and validate environment variables at startup, in CI, and from coding agents.
- [Quickstart](https://pr-1-ee19382a0710.thally.app/quickstart): Run your first Specdiff comparison and your first Envlock validation in under five minutes.

## Specdiff

### Overview

- [Specdiff Overview](https://pr-1-ee19382a0710.thally.app/specdiff/overview): Breaking-change detection for JSON Schema and OpenAPI. Compare a before and after document and get every change classified by severity, with a JSON-pointer path, a stable rule code, and a human-readable message.
- [CI Integration](https://pr-1-ee19382a0710.thally.app/specdiff/ci-integration): Run Specdiff in CI/CD pipelines to catch breaking API changes before they merge. Includes a GitHub Actions recipe, exit code reference, and options for customizing failure thresholds and report formats.

### Reference

- [@specdiff/core API Reference](https://pr-1-ee19382a0710.thally.app/specdiff/core-api): Complete API reference for @specdiff/core — types, diff functions, result processing, rule helpers, formatters, JSON pointer utilities, ref resolution, and constants.
- [@specdiff/cli Reference](https://pr-1-ee19382a0710.thally.app/specdiff/cli): Command-line interface reference for @specdiff/cli — compare JSON Schema and OpenAPI documents, list rules, and integrate into CI pipelines.
- [Rule catalogue](https://pr-1-ee19382a0710.thally.app/specdiff/rules): Complete reference for all 45 Specdiff rules covering JSON Schema and OpenAPI breaking-change detection, including direction-dependent severity.
- [MCP server](https://pr-1-ee19382a0710.thally.app/specdiff/mcp): Reference for the @specdiff/mcp package, which exposes Specdiff as an MCP server for AI coding agents.

## Envlock

### Overview

- [Overview](https://pr-1-ee19382a0710.thally.app/envlock/overview): Typed environment contracts for Node.js — declare once, then validate, type, document, and diff everywhere.

### Reference

- [Field types](https://pr-1-ee19382a0710.thally.app/envlock/field-types): Complete reference for the env builder namespace — all ten field types and their chain modifiers.
- [Validation](https://pr-1-ee19382a0710.thally.app/envlock/validation): Schema definition, environment parsing, error handling, dotenv support, and projection utilities.
- [@envlock/cli](https://pr-1-ee19382a0710.thally.app/envlock/cli): Command-line tool for validating environment variables against an Envlock contract in local development and CI.
- [@envlock/mcp](https://pr-1-ee19382a0710.thally.app/envlock/mcp): MCP server that exposes Envlock schema validation, inspection, and diffing to coding agents and AI tools.