# The Module SDK: guides and references for coding agents

What the Module SDK contains, how a coding agent reads it through the connector, which skill or reference to open for each job, and how it stays current.

The **Module SDK** is the set of guides, references and examples that teach a coding agent how to build a module the way Data Visions expects. Claude, Claude Code, Cursor and other agents read it before they write a file, so the module they build passes the module check the first time more often.

You rarely read the SDK yourself. Your agent does, through the connector. This page explains what is in it, so you know what to point your agent at.

## What is in the SDK

| Part | What it is |
|---|---|
| `SKILL.md` | The entry point: the workflow from idea to deploy, the rules every module follows, and a reading guide that sends the agent to the right skill for each task. |
| `CLAUDE.md` | A short note an agent loads automatically when it opens the SDK folder. It says: coach first, then read `SKILL.md`. |
| `QUICKSTART.md` | Setup for people working from a copy of the SDK with the command line. |
| `MODULE_SDK.md` | The complete guide in one long file. A fallback; the skills cover the same ground in smaller pieces. |
| `CHANGELOG.md` | What changed in each SDK version. |
| `VERSION` | The SDK's version number. |
| `skills/` | How-to guides, one folder per task, each with a `SKILL.md`. |
| `references/` | Detailed references: every manifest field, every platform feature, the review rules, the findings format. |
| `examples/` | A reference module, `examples/assets/`, that passes validation with no errors or warnings. |
| `platform-assets/` | The platform's own page scripts and styles (`platform-sdk.js`, `platform.css`, `platform-forms.js`, `platform-charts.js` and others), so an agent can see the exact functions a module page may call. |
| `browser-extension/` | The Data Visions browser extension's source, for agents that drive the person's own browser. |
| The CLI | The `dv` command line. See [Install and sign in to the CLI](article:9b9b3a9f-142d-4159-aae3-a9414adb33fc). |

The SDK is versioned. Its version is in `VERSION`, and the connector reports it each time an agent opens the index.

## How an agent reads it: `sdk_doc`

Agents read the SDK live through the connector's **`sdk_doc`** tool, so they always get the current version, not a copy from last month. Connect your agent first: see [The Data Visions connector (MCP)](article:bae9542d-06d2-45f3-a4d5-506872f3bfde).

- **With no path**, `sdk_doc` returns the index: the SDK version, the file to start with (`skills/starting-a-module/SKILL.md`), the workflow file (`SKILL.md`) and every document it serves, each with its path, a one-line description and its size.
- **With a path**, such as `references/manifest-schema.md` or `examples/assets/module.json`, it returns that one document.
- **Long documents come in pages** of up to 60,000 characters. Each page says where it starts, the document's total length and the `next_offset`. The agent calls `sdk_doc` again with `offset` set to that number for the next page.

What `sdk_doc` serves: the top-level files (`SKILL.md`, `CLAUDE.md`, `QUICKSTART.md`, `MODULE_SDK.md`, `CHANGELOG.md`, `VERSION`) and everything under `skills/`, `references/`, `examples/` and `platform-assets/`. It does not serve the CLI's code or the browser extension; install the CLI instead.

A second tool, **`platform_features`**, returns `references/platform-features.md` directly, paged the same way: the list of everything a module may call on the platform.

**Only Workspace Admins** can use `sdk_doc` and `platform_features`, the same people who can build modules.

## Can I download the SDK?

Read it through the connector. A downloadable copy is not offered to workspaces. Reading it live is also safer: manifest rules change between versions, and a module built from an old copy can fail the module check today.

## Where an agent starts

An agent's first reads, in order:

1. **`sdk_doc` with no path**, for the index and the version.
2. **`skills/starting-a-module/SKILL.md`** when you want something new. It coaches: it asks what problem you are solving, who uses the module and what data it holds, shows what the platform already provides, and agrees a short plan with you before writing anything.
3. **`SKILL.md`** for the workflow and the rules.
4. **`references/review-rules.md`** before writing code. These are the rules the module check's AI review judges every module by.
5. **`examples/assets/`** as the pattern to copy, under a new module code (the code `ASSETS` is already taken).

After that the agent opens skills and references only when it needs them. The SDK is built for that: an agent should not load everything at once.

## Skills

Each skill is one task. The agent picks the one that matches what it is doing.

| Skill | Use it for |
|---|---|
| `starting-a-module` | Coaching from an idea to an agreed plan before any file is written. |
| `connecting-to-platform` | Signing in, choosing the workspace and checking the session. |
| `editing-manifest` | Writing `module.json`: tables, permissions, agent, settings, screens. |
| `writing-tools` | Writing `@platform_tool` functions in `ai/tools.py`, including tools that run on the Bridge. |
| `writing-agent-skills` | Writing `SKILL.md` packages inside a module's `ai/skills/` folder. |
| `using-storage` | Storing uploaded files and generated files with signed links, never in table columns. |
| `building-for-phones` | Making every page work in the DV Mobile app, phone features through `Platform.device`, and the `mobile` manifest section. |
| `registering-datasets` | Publishing the module's data to dashboards and the Dashboard Agent. |
| `writing-report-templates` | Ready-made reports on the module's Reports tab, and per-report permissions. |
| `integrating-modules` | Connecting to other modules or outside APIs through declared contracts. |
| `using-integrations` | Using a system the workspace has connected, such as Microsoft 365, without handling credentials. |
| `adding-a-data-source` | Writing a new source adapter so Data Connectors can read a new kind of system. |
| `using-browser-extension` | Letting a module's agent open pages, click and read in the person's own Chrome or Edge. |
| `testing-modules` | Testing service logic and tools without a running platform or database. |
| `validating-locally` | Running the validator before uploading and fixing what it finds. |
| `writing-qa-procedures` | Writing `qa/procedures.json`: who uses the module and what to test. Required for the Marketplace. |
| `deploying` | Deploying, updating, logs and troubleshooting, command by command. |
| `using-the-cli` | Working a workspace from a terminal for the person signed in. |
| `publishing` | Submitting to the Marketplace, tracking review and shipping updates. |
| `sites-with-agents` | Asking an agent to make or change a website and connect it to a module. |
| `building-a-site` | Building, hosting and publishing a workspace's public website. |
| `site-design` | Designing a website and writing its copy. |
| `site-checking` | Checking every page of a website version before it goes live. |

## References

| Reference | What it covers |
|---|---|
| `references/manifest-schema.md` | Every field in `module.json`. See [Module manifest (module.json) reference](article:42e987e5-382d-4d07-ab9b-13a60b831dee). |
| `references/platform-features.md` | Everything a module may call on the platform, with the API, the manifest entry and the limits. If it is not listed, a module does not have it. |
| `references/review-rules.md` | The rules (R1 to R11) the module check's AI review applies. |
| `references/validation-findings.md` | The format of every finding (code, why, fix, docs) and the catalogue of findings. |
| `references/tool-decorator.md` | The `@platform_tool` contract and the tool context. |
| `references/tenant-data-connector.md` | How module code reads and writes its own tables. |
| `references/skill-spec.md` | The format for skills inside a module. |
| `references/agents-and-models.md` | How a module's agent picks its model, whose AI key it uses, and calling a model from module code. |
| `references/integration-contracts.md` | Declaring what a module provides and uses, for other modules and outside services. |
| `references/browser-tool-actions.md` | The actions of the platform's `browser` tool. |
| `references/module-icons.md` | The required module icon: file rules and how to draw it. |
| `references/module-runbooks.md` | Shipping step-by-step runbooks with a module's help. |

## How it stays current

The SDK changes as the platform does. Each change is recorded in **`CHANGELOG.md`**, newest first: new skills, new manifest sections, new findings, and findings that will turn from warnings into errors.

- An agent reading through the connector always gets the live version.
- If you or your agent work from an older copy, compare its `VERSION` with the version `sdk_doc` reports, and read `CHANGELOG.md` for what changed in between.
- `dv version` shows the version of the CLI you installed. If it is behind, update it with the steps the connector's `cli_setup` tool gives.

## Good to know

- **Point your agent at `skills/starting-a-module/SKILL.md`** for anything new. It plans with you first and writes code second.
- **The SDK describes your workspace only.** A module you build is owned by your workspace and deployed there.
- **New findings often start as warnings.** `CHANGELOG.md` says when they become errors, so fix them early.
- **For a step-by-step build**, see [Build a module with a coding agent, start to finish](article:6e6343d4-3801-4e7d-a21a-9722fb4ee89b).


Source: https://datavisions.ai/docs/developer-tools/the-module-sdk-guides-and-references-for-coding-agents
