skills.rest
typemd
typemdOFFICIAL
Explore all skills by this author →
GitHub

instructions-guide

Export vault skill instructions and type context as machine-readable JSON.

9|2|Updated Mar 4, 2026
Search Tags:#context#cli#skills#vault#instructions#ai-integration#typemd
One-click install
npx skills add https://github.com/typemd/typemd --skill instructions-guide
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: instructions-guide
Source: https://github.com/typemd/typemd/tree/main/marketplace/plugins/typemd/skills/instructions-guide
Command: npx skills add https://github.com/typemd/typemd --skill instructions-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about instructions-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I feed vault context into AI skill instructions for schema inference?▼

To feed vault context into AI skill instructions, you request embedded skill instructions to produce machine-readable JSON containing the skill's markdown body alongside a context object with live vault types and properties. This output enables schema-aware AI tasks like schema inference and object generation.

What is the best way to expose typemd type definitions to an external AI agent?▼

The best way to expose typemd type definitions to an external AI agent is to export vault-enriched skill instructions as JSON. This bundles the markdown instructions with live type context, allowing the agent to operate with accurate knowledge of your object model without manual assembly.

Can I customize AI instructions per vault using local overrides?▼

Yes, you can customize AI instructions per vault by placing local override files under the .typemd/instructions directory. The guide honors these local overrides to tailor the exported skill behavior and context for specific vault requirements.

How do I export raw SKILL.md files for Claude Code style directories?▼

You can export raw SKILL.md files for Claude Code style directories by requesting the raw skill instruction output. This produces the unmodified markdown body needed to install embedded skills directly into external AI tool skill directories.

How do I list embedded skills for AI workflow orchestration?▼

To list embedded skills for AI workflow orchestration, you request the skill instruction catalog. This outputs a structured catalog of available skills and their descriptions, enabling discovery and orchestration of schema-aware tasks across your vault.

Related Skills

Explore More Software Engineering Skills→
typemdtypemd
9

importer

Convert markdown files into TypeMD objects using the tmd CLI.

Official
Intermediate
typemdtypemd
9

onboarding

Scan markdown collections and generate an executable ImportPlan for TypeMD vaults.

Official
Advanced
inpinitiinpiniti

core

Define schemas, catalogs, and AI prompts for json-render workflows.

Community
Advanced
BrandondaymdrBrandondaymdr
1

obsidian-context

Parse Obsidian Markdown notes and wikilinks to retrieve project context.

Community
Intermediate