CloudBoosterDocs
MCP ReferenceTools

render_adr

Render an Architecture Decision Record from a deployment plan

render_adr

Render an Architecture Decision Record (ADR) from a deployment plan.

Takes a resolved composition plan and returns an ADR as a single Markdown string, suitable for committing alongside infrastructure code.

  • Family: composition
  • Source: cbx-mcp/src/cbx_mcp/tools/compose.py::render_adr
  • Backend: POST /v1/compose/render-adr

Input schema

{
  "type": "object",
  "properties": {
    "plan": {
      "type": "object",
      "description": "Resolved composition plan, typically the `result.plan` of aws_resolve_composition."
    }
  },
  "required": ["plan"]
}

Output schema

{
  "type": "object",
  "properties": {
    "isError": { "type": "boolean" },
    "result": {
      "type": "object",
      "properties": {
        "rendered": {
          "type": "string",
          "description": "ADR rendered as a single Markdown string."
        }
      },
      "required": ["rendered"]
    },
    "error": { "type": "string" }
  },
  "required": ["isError"]
}

Example call

{
  "name": "render_adr",
  "arguments": {
    "plan": {
      "components": [
        { "type_id": "aws:s3/bucket@v1", "name": "bucket" }
      ],
      "deploy_order": ["bucket"],
      "errors": [],
      "warnings": [],
      "auto_completed": [],
      "conflicts": [],
      "rule_set_hash": null
    }
  }
}

Example result

Illustrative — rendered is a single Markdown document; the snippet below is truncated for readability.

{
  "isError": false,
  "result": {
    "rendered": "# ADR-001: Static site with S3\n\n## Context\n...\n\n## Decision\n...\n\n## Consequences\n..."
  }
}

Previous

aws_resolve_composition

Next

render_diagram

On this page