ai.imboard/dossier

MCP server for dossier automation standard - enables LLMs to discover, verify, and execute dossiers

4AGPL-3.0ai-ml

Install

Config snippet generator goes here (5 client tabs)

README

# Dossier — Automation Instructions for AI Agents

**Stop writing brittle scripts. Start writing instructions that AI executes intelligently.**

[![CI](https://github.com/imboard-ai/ai-dossier/actions/workflows/ci.yml/badge.svg)](https://github.com/imboard-ai/ai-dossier/actions/workflows/ci.yml)
[![Examples](https://github.com/imboard-ai/ai-dossier/actions/workflows/test-examples.yml/badge.svg)](https://github.com/imboard-ai/ai-dossier/actions/workflows/test-examples.yml)
[![npm version](https://img.shields.io/npm/v/@ai-dossier/cli)](https://www.npmjs.com/package/@ai-dossier/cli)
[![npm downloads](https://img.shields.io/npm/dm/@ai-dossier/cli)](https://www.npmjs.com/package/@ai-dossier/cli)
[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](LICENSE)
[![Spec](https://img.shields.io/badge/Dossier%20Spec-v1.0-blue)](docs/reference/README.md)
[![MCP Ready](https://img.shields.io/badge/MCP-Ready-brightgreen)](mcp-server)
[![Verification](https://img.shields.io/badge/Verification-Checksums%20%26%20Signatures-yellow)](docs/explanation/security-model.md)
[![GitHub](https://img.shields.io/github/stars/imboard-ai/ai-dossier?style=social)](https://github.com/imboard-ai/ai-dossier)

> **Quick Concept**
> Dossier turns plain-text instructions into executable workflows with built-in verification.
> Like Dockerfiles for AI automation — structured, portable, verifiable.

```
  ┌──────────────────────────────────────────────────────────────────────┐
  │                                                                      │
  │    Write instructions       Verify integrity       AI executes       │
  │    in Markdown (.ds.md)     with checksums &       the workflow      │
  │                             signatures             intelligently     │
  │                                                                      │
  │    ┌──────────┐    sign     ┌──────────┐   run     ┌──────────┐     │
  │    │  Author  │ ─────────> │  Verify  │ ────────> │ AI Agent │     │
  │    └──────────┘            └──────────┘            └──────────┘     │
  │         │                       │                       │            │
  │     .ds.md file            checksum +              validated         │
  │     with JSON              signature               results with     │
  │     frontmatter            verification            evidence         │
  │                                                                      │
  └──────────────────────────────────────────────────────────────────────┘
```

**New here?** → [5-min Quick Start](docs/getting-started/installation.md) | **Using Claude Code?** → [MCP in 60 Seconds](docs/tutorials/mcp-quickstart.md) | **Want to try now?** → [Get started in 30 seconds](#get-started)

---

## At a Glance

```mermaid
flowchart LR
    A["📝 Create\n.ds.md file"] --> B["🔏 Sign\nchecksum +\nsignature"]
    B --> C["✅ Verify\nintegrity &\nauthenticity"]
    C --> D["🤖 Execute\nAI runs the\nworkflow"]
    D --> E["📋 Validate\nsuccess criteria\n& evidence"]

    style A fill:#e3f2fd,stroke:#1565c0,color:#0d47a1
    style B fill:#fce4ec,stroke:#c62828,color:#b71c1c
    style C fill:#fff3e0,stroke:#ef6c00,color:#e65100
    style D fill:#e8f5e9,stroke:#2e7d32,color:#1b5e20
    style E fill:#f3e5f5,stroke:#6a1b9a,color:#4a148c
```

**What**: Structured instruction files (`.ds.md`) that AI agents execute intelligently
**Why**: Replace brittle scripts with adaptive, verifiable automation that handles edge cases naturally
**Safety**: Built-in checksums, cryptographic signatures, and CLI verification tools
**Works with**: Claude, ChatGPT, Cursor, any LLM — no vendor lock-in

**Status**: Protocol v1.0 (stable spec) | CLI v0.8.0 | 15+ example templates | Active development

> **File conventions**: Dossiers use `.ds.md` (immutable instructions) and `.dsw.md` (mutable working files). Frontmatter uses `---dossier` (JSON) instead of `---` (YAML) to avoid parser conflicts. [Learn more](docs/explanation/faq.md#what-do-the-dsmd-and-dswmd-file-extensions-mean)

---

## Get Started

### 1. Run a dossier — zero install

Pick any LLM you already have and paste this:

```
Analyze my project using the dossier at:
https://raw.githubusercontent.com/imboard-ai/ai-dossier/main/examples/guides/context-engineering-best-practices.ds.md
```

That's it. The LLM reads the dossier and follows its instructions — no tools needed.

Want to verify it first?

```bash
npx @ai-dossier/cli verify https://raw.githubusercontent.com/imboard-ai/ai-dossier/main/examples/guides/context-engineering-best-practices.ds.md
```

### 2. Add the MCP server to Claude Code

One command gives Claude Code native dossier support — discover, verify, and execute dossiers without copy-pasting URLs:

```bash
claude mcp add dossier --scope user -- npx @ai-dossier/mcp-server
```

Then ask Claude: *"List available dossiers"* or *"Run the scaffold-typescript-project dossier"*.

<details>
<summary>Alternative: Claude Code plugin (auto-updates)</summary>

`