write_architecture_doc
Create architecture decision records or system design documents, index them into a vector store, and push to git automatically. Supports Mermaid diagrams for component relationships.
Instructions
Create an architecture decision or system design document, index it, and auto-push.
Side effects: creates architecture/YYYY-MM-DD-{slug}.md in the docs path,
indexes it into the vector store, and pushes to git if configured.
Overwrites an existing file with the same title.
Use for system design, ADRs, and component relationships.
Use write_api_doc() for HTTP endpoint specs, write_best_practice()
for coding patterns, write_bugfix_summary() after fixing bugs.
Include a Mermaid diagram in the diagrams field for best results.
Args:
title: Short title (e.g. "Payment Service Architecture")
overview: High-level description of the system/component
decisions: Key architectural decisions made and why
trade_offs: Alternatives considered and rejected, pros/cons
components: Optional component breakdown (optional)
diagrams: Optional Mermaid or ASCII diagrams (optional)
project: Target project name (optional)
Returns:
Saved filename, chunk count, and whether auto-push succeeded.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | ||
| overview | Yes | ||
| decisions | Yes | ||
| trade_offs | Yes | ||
| components | No | ||
| diagrams | No | ||
| project | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |