instructions-guide

What problem does it solve?

Typemd's object model and per-vault type definitions are not readily available to external AI tools, making it hard to build context-aware skill workflows or to convert markdown into structured typemd objects without manual context assembly. This guide provides a standardized way to expose embedded skill instructions combined with vault context so AI assistants can operate with accurate knowledge of types, properties, and available skills.

Core Features & Use Cases

• Outputs a catalog of embedded skills and their descriptions for discovery and orchestration.
• Produces JSON that bundles a skill's markdown instructions together with live vault context (types, properties, emoji, descriptions) to enable schema-aware AI tasks like importing, exploration, and schema suggestion.
• Supports exporting raw SKILL.md for installing into Claude Code style skills directories and allows local overrides via .typemd/instructions to customize behavior per vault.
• Use Case: Pipe the explorer instructions and vault context into an AI agent to automatically infer missing type properties and suggest a migration plan for an existing notes collection.

Quick Start

Request the explore skill with vault context and pipe the JSON output to your AI assistant to get schema suggestions for your vault.