mdplane CLI
Use this skill when shell access is available and the task should be solved with mdplane commands.
Operating Rules
-
OpenAPI and server behavior are the source of truth.
-
Do not invent commands, flags, or response fields.
-
Prefer least privilege:
-
read key for read/search (scoped)
-
append key for appends
-
write key only for mutating file/folder state
-
API key for /api/v1/* control endpoints (workspace-wide search, exports, deleted, agents)
-
Never print capability URLs, API keys, or session tokens.
Standard Workflow
-
Confirm deployment target (https://api.mdplane.dev , self-host, or local).
-
Resolve auth mode from profile/env/flags.
-
Execute command(s) with minimal required capability.
-
Validate outcomes (status , files , read , check-keys as needed).
-
Summarize results and any follow-up action.
Command Surface
The canonical command inventory and auth expectations are in:
- ./references/command-surface.md
Use it before giving command guidance.
Canonical References
- ./references/canonical-links.md
Read these references when the request touches new endpoints, auth edge cases, orchestration, webhooks, export, or folder operations.
Quick Checks
mdplane --help mdplane <command> --help
If CLI behavior appears to drift from docs, trust source and OpenAPI links in references and flag the drift.