Context commands expose Akan workspace structure in forms that people, agents, CI jobs, and MCP clients can consume.
Use `context` to understand the workspace, `doctor` to validate conventions, and `mcp` when an MCP-aware client should query the same information over stdio.
context
Print agent-readable Akan workspace context.
Use it when an external coding agent, CI job, or IDE extension needs a structured summary of apps, libraries, packages, modules, generated files, validation commands, and module abstracts.
Signature
Options
Option
Type
Default
Enum / Flag
Description
--format
String
markdown
markdown | json
Output format. Use json for tools and markdown for people or chat context.
--app
String
-
nullable
Limit the context to one app.
--module
String
-
nullable
Limit module output and include the matching *.abstract.md content first.
--format
Type
String
Default
markdown
Enum / Flag
markdown | json
Description
Output format. Use json for tools and markdown for people or chat context.
--app
Type
String
Default
-
Enum / Flag
nullable
Description
Limit the context to one app.
--module
Type
String
Default
-
Enum / Flag
nullable
Description
Limit module output and include the matching *.abstract.md content first.
Notes
Name
Description
abstract exposure
Workspace summaries include abstract metadata only; module-scoped context includes the abstract body.
privacy
The context analyzer does not print .env values or secrets.
abstract exposure
Description
Workspace summaries include abstract metadata only; module-scoped context includes the abstract body.
privacy
Description
The context analyzer does not print .env values or secrets.
Examples
doctor
Report Akan workspace convention diagnostics.
Use it before or after agent changes to catch unsupported files, missing module abstracts, and convention drift in machine-readable form.
Signature
Options
Option
Type
Default
Enum / Flag
Description
--format
String
text
text | json
Output format. Use json for agent validation loops.
--strict
Boolean
false
-
Treat recommended conventions such as missing module abstracts as errors.
--format
Type
String
Default
text
Enum / Flag
text | json
Description
Output format. Use json for agent validation loops.
--strict
Type
Boolean
Default
false
Enum / Flag
-
Description
Treat recommended conventions such as missing module abstracts as errors.
Examples
mcp
Start the read-only Akan MCP server over stdio.
The server exposes workspace context, module context, guideline instructions, command explanations, diagnostics, and resources for MCP-aware coding agents.
Signature
Notes
Name
Description
mode
Read-only. It does not write files, scaffold modules, or call LLM providers.
module context
`get_module_context` returns the module abstract first, then surrounding module file metadata.
mode
Description
Read-only. It does not write files, scaffold modules, or call LLM providers.
module context
Description
`get_module_context` returns the module abstract first, then surrounding module file metadata.
