Skip to content

SDKs & Packages

PLAYBOOK.md provides official packages for parsing, validating, and summarizing playbook files. All implementations follow the v0.1.0 spec and produce identical results.

TypeScript / JavaScript

Terminal window
npm install @playbook-md/core
import { parsePlaybook, validatePlaybook, summarizePlaybook } from '@playbook-md/core';
const result = parsePlaybook(markdownString);
if (result.definition) {
console.log(result.definition.title);
console.log(`${result.definition.steps.length} steps`);
}
const validation = validatePlaybook(markdownString);
console.log(validation.valid); // true or false

What’s included:

  • parsePlaybook(markdown) — Parse .playbook.md files into a structured PlaybookDefinition
  • validatePlaybook(markdown) — Semantic validation (variable scoping, output shadowing, branch conditions)
  • summarizePlaybook(definition) — Compact summary (title, step count, directives used, etc.)
  • playbookToJson(markdown) / jsonToPlaybook(json) — Format conversion

Registry: npmjs.com/package/@playbook-md/core


Python

Terminal window
pip install playbook-md
from playbook_md import parse_playbook, validate_playbook, summarize_playbook
result = parse_playbook(markdown_string)
if result.definition:
print(result.definition.title)
print(f"{len(result.definition.steps)} steps")
validation = validate_playbook(markdown_string)
print(validation.valid) # True or False

What’s included: Same capabilities as the TypeScript package — parser, validator, summarizer, and converter. Zero dependencies, Python 3.10+.

Registry: pypi.org/project/playbook-md


Go

Terminal window
go get github.com/PLAYBOOK-MD/playbook-integrations/packages/go
import playbook "github.com/PLAYBOOK-MD/playbook-integrations/packages/go"
result := playbook.ParsePlaybook(markdownString)
if result.Definition != nil {
fmt.Println(result.Definition.Title)
fmt.Printf("%d steps\n", len(result.Definition.Steps))
}
validation := playbook.ValidatePlaybook(markdownString)
fmt.Println(validation.Valid)

What’s included: Same capabilities as the TypeScript package. Zero dependencies, Go 1.22+.

Registry: pkg.go.dev


MCP Server

The MCP server exposes PLAYBOOK.md operations as tools for AI agents via the Model Context Protocol.

Terminal window
npx @playbook-md/mcp

Tools provided:

  • playbook_read — Parse a playbook (structured or summary mode)
  • playbook_validate — Check spec compliance
  • playbook_write — Generate a spec-aware prompt for creating playbooks
  • playbook_convert — Convert between markdown and JSON formats

Resources: Embedded spec references (playbook://spec/format, playbook://spec/inputs, etc.)

Prompts: Templates for creating, reviewing, and explaining playbooks.

Registry: npmjs.com/package/@playbook-md/mcp


Agent Skills

If your agent environment supports skills.sh, install all five PLAYBOOK.md skills:

Terminal window
npx skills add PLAYBOOK-MD/playbook-integrations

Skills are pure markdown instructions — no code. They teach agents how to read, write, validate, run, and convert playbooks using their existing capabilities.


Source

All packages live in the playbook-integrations monorepo. The parser, validator, and summarizer are implemented independently in each language but produce identical results against the spec.


See Also

  • Tools — CLI for validating and scaffolding playbooks, VS Code extension with syntax highlighting and real-time validation, GitHub Action for CI, editor integrations, and pre-commit hook