write_setup_doc
Create a setup or deployment document with prerequisites, steps, and verification. The document is indexed and auto-pushed to git for infrastructure and CI/CD guides.
Instructions
Create a setup, deployment, or infrastructure document, index it, and auto-push.
Side effects: creates setup/{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 environment setup guides, CI/CD configuration, Docker or
infrastructure docs, and deployment runbooks.
Use write_architecture_doc() for system design rather than how-to guides.
Args:
title: Short title (e.g. "Local Development Setup")
prerequisites: Tools, accounts, or config required before starting
steps: Step-by-step instructions (numbered list recommended)
verification: How to confirm the setup is working correctly
troubleshooting: Common issues and their fixes (optional)
project: Target project name (optional)
Returns:
Saved filename, chunk count, and whether auto-push succeeded.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| steps | Yes | ||
| title | Yes | ||
| project | No | ||
| verification | Yes | ||
| prerequisites | Yes | ||
| troubleshooting | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |