Skip to content

Commit 60e4fc2

Browse files
committed
docs(calm-suite): clarify ARB term, add finalize_architecture to tool table, cross-link ARB guide
- Add 'What is an ARB?' section to convert-arb-to-calm.md - Add finalize_architecture to Render and Validate tool table in mcp-server.md - Update read_calm_guide description to mention topic="arb-conversion" variant - Add ARB conversion usage example with 6-step MCP call sequence - Fix tool count 21 → 22 Signed-off-by: Gourav Shah <gjs@opsflow.sh>
1 parent 55a1025 commit 60e4fc2

2 files changed

Lines changed: 32 additions & 3 deletions

File tree

docs/docs/calm-studio/developer-guide/mcp-server.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ CalmStudio ships a standalone MCP (Model Context Protocol) server that lets AI a
1111

1212
[Model Context Protocol](https://modelcontextprotocol.io/) is an open standard for AI tools to call structured functions — similar to REST APIs, but designed for AI clients. An MCP server exposes a set of **tools** that an AI assistant can invoke.
1313

14-
CalmStudio's MCP server (`@calmstudio/mcp-server`) exposes 21 tools covering the full lifecycle of CALM architecture management: guide, nodes, relationships, architecture-level operations, views, I/O, rendering, and validation.
14+
CalmStudio's MCP server (`@calmstudio/mcp-server`) exposes 22 tools covering the full lifecycle of CALM architecture management: guide, nodes, relationships, architecture-level operations, views, I/O, rendering, and validation.
1515

1616
## Available Tools
1717

1818
### Guide
1919

2020
| Tool | Description |
2121
|------|-------------|
22-
| `read_calm_guide` | Returns the CALM reference guide: all 9 node types, 5 relationship types, interface types, a complete 3-node example, and usage tips. Start here. |
22+
| `read_calm_guide` | Returns the CALM reference guide: all 9 node types, 5 relationship types, interface types, a complete 3-node example, and usage tips. Pass `topic="arb-conversion"` to get the step-by-step [ARB → CALM conversion skill](../guides/convert-arb-to-calm.md). Start here. |
2323

2424
### Architecture
2525

@@ -68,6 +68,7 @@ CalmStudio's MCP server (`@calmstudio/mcp-server`) exposes 21 tools covering the
6868
|------|-------------|
6969
| `validate_architecture` | Validate a CALM file and return errors and warnings |
7070
| `render_diagram` | Generate an SVG diagram using ELK layout with color-coded node types |
71+
| `finalize_architecture` | Validate, top up AIGF governance decorator, and optionally render SVG in one call — use as the last step of any AI-driven conversion workflow |
7172

7273
## Setup with Claude Code
7374

@@ -110,7 +111,7 @@ If you installed globally, use the binary directly:
110111
}
111112
```
112113

113-
Restart Claude Code. The 21 CalmStudio tools will appear in the tool list.
114+
Restart Claude Code. The 22 CalmStudio tools will appear in the tool list.
114115

115116
### HTTP Mode
116117

@@ -187,6 +188,26 @@ to each one with requirement-url pointing to our security policy.
187188

188189
Claude Code calls `query_nodes` to find databases, then `update_node` for each.
189190

191+
### Convert an AI Reference Architecture (ARB) to CALM
192+
193+
[FINOS Labs AI Reference Architecture Blueprints (ARBs)](https://github.com/finos-labs/ai-reference-architecture-library) are markdown documents describing layered AI system designs (multi-agent, RAG, agentic pipelines, …). The MCP server can convert any ARB into a validated CALM 1.2 artifact with FINOS AIGF governance overlay:
194+
195+
```
196+
Convert the multi-agent reference architecture at
197+
https://github.com/finos-labs/ai-reference-architecture-library/blob/main/Library/reference-architecture/multi-agent/ma_ref_arch_jan_2026.md
198+
into a CALM 1.2 architecture. Save to multi-agent.calm.json.
199+
```
200+
201+
Claude Code will call:
202+
1. `read_calm_guide` with `topic="arb-conversion"` — load the ARB conversion skill
203+
2. `create_architecture` — initialise the file
204+
3. `batch_create_nodes` — create all AI nodes (AIGF decorator auto-attaches)
205+
4. `add_relationship` — wire up inter-layer connections
206+
5. `update_node` *(optional)* — attach domain-oriented controls for governance posture
207+
6. `finalize_architecture` — validate, top up AIGF overlay, render SVG
208+
209+
See the full [Convert ARB markdown to CALM](../guides/convert-arb-to-calm.md) guide for the complete step-by-step, layer-to-node-type mapping, and worked example.
210+
190211
## How the Server Connects to CalmStudio
191212

192213
The MCP server operates on **CALM JSON files on disk** — it reads and writes `.json` files directly using Node.js `fs`. It does not require the CalmStudio web app to be running.

docs/docs/calm-studio/guides/convert-arb-to-calm.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ description: Convert FINOS Labs–style AI reference architecture markdown into
55

66
# Convert ARB markdown to CALM
77

8+
## What is an ARB?
9+
10+
An **AI Reference Architecture Blueprint (ARB)** is a markdown document published by [FINOS Labs](https://github.com/finos-labs/ai-reference-architecture-library) that describes a canonical layered design for an AI system — such as a multi-agent pipeline, a RAG application, or an agentic workflow. ARBs define the major components (agents, gateways, LLMs, vector stores, …) and their interactions in human-readable prose and tables, but do not produce a machine-readable artifact on their own.
11+
12+
This guide converts an ARB into a validated CALM 1.2 `.calm.json` file so the architecture can be visualised, version-controlled, and assessed for FINOS AI Governance Framework (AIGF) compliance.
13+
14+
---
15+
816
How to convert a [FINOS Labs–style AI reference architecture](https://github.com/finos-labs/ai-reference-architecture-library) markdown document into a valid CALM 1.2 architecture using the CALMStudio MCP server.
917

1018
The conversion is driven by the AI coding agent the operator is already using (Claude Code, Codex, Cursor, …). No LLM logic lives in CALMStudio itself — the agent reads the source markdown, performs extraction in its own session, and calls existing MCP tools to assemble the CALM artifact.

0 commit comments

Comments
 (0)