Build with an AI Agent

The SDK's type surface is generated from the platform's official collection, not hand-written, and it changes between releases. An agent working from memory invents a getPatientProblems() that does not exist, or reaches for patient.dob when the field is patient.demographics.dateOfBirth. Both look right in review and fail at runtime.

Install the skill and your agent looks the answer up instead.

Building a service app's server? See Build with an AI Agent for the Backend SDK.

Claude Code

@vimconnect/app-sdk ships a skill named vim-app-sdk-docs. Copy it into your project:

mkdir -p .claude/skills
cp -r node_modules/@vimconnect/app-sdk/skills/vim-app-sdk-docs .claude/skills/vim-app-sdk-docs

That is the whole setup. From then on, whenever you ask Claude to build, fix, or explain anything touching initVimSDK, sdk.ehr.*, workflow events, or writeback, it fetches the current reference before answering rather than recalling an older one.

Other agents

No skill format required — point your agent at these URLs and tell it to read them before writing SDK code:

• /llms-full.txt — every page on this site as plain markdown
• /collection/api-reference.json — the generated entity types, events, context keys, and method signatures

Fetch both. The API reference tables render client-side from the JSON, so llms-full.txt carries the guides and worked examples but points at the JSON for the exact names and signatures rather than inlining them.

Every page here also has a Copy as Markdown button when you want to hand over one page instead of the whole reference.

Machine-readable resources

• /llms.txt — one-line summary of every page, grouped by section
• /llms-full.txt — the full documentation as one markdown file
• /collection/api-reference.json — the generated API reference

Next Steps

• Start from the Demo App — a working app that already uses the real surface
• Quick Start — build a minimal app from scratch
• API Reference — the human-readable version of the JSON above