Sandbox — LSD is in active testing. All systems operational·payments are test-mode (no real charges).
Overview Use Cases News Docs Tool Store Support Community Get LSD
All docs
Docs/ API Reference/ describe_api/ describe_markdown
describe_api· function

describe_markdown

renders the api snapshot as a markdown context cheat-sheet for an ai editor

Python
describe_markdown(data: Optional[Dict[str, Any]] = None) -> str

Returns str — a Markdown context cheat-sheet of the snapshot

Parameters#

name type default description
data Optional[Dict[str, Any]] None a snapshot from describe_api(); recomputed fresh when omitted

Example#

Python
from lsdtools.advanced import describe_markdown

open("LSD_CONTEXT.md", "w").write(describe_markdown())

This is exactly what lsd api context prints:

bash
lsd api context > LSD_CONTEXT.md

Notes#

Lives in lsdtools.advanced. Takes the same optional data snapshot (recomputed when omitted). The rendered Markdown includes the one import rule, how to write a step, the full public API name list, and every available step and entity with its signature and docstring — sized to hand to an AI assistant as project context so it generates code against the current surface.

See also#

API: describe_api · describe_text · lsdtools.advanced

Guides: CLI commands

By LSD Team · Last updated Jul 17, 2026 Ask on Discord View as Markdown