Build with an AI Agent

The Backend SDK's client.api surface is generated, not hand-written, and it changes between releases. An agent working from memory invents an operation that does not exist, or sends patient.dob when the input is demographics.dateOfBirth. Both look right in review and fail at runtime.

Install the skill and your agent looks the answer up instead. Building an app that runs inside the EHR? See Build with an AI Agent for the App SDK.

Claude Code

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

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

From then on, whenever you ask Claude to build, fix, or explain anything touching VimConnectBackendClient or client.api.*, it looks up the operation, its inputs, the record types and their protected fields before writing the call.

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/backend-sdk-reference.json — the generated operations, inputs, record types and protected fields

Fetch both. The API reference pages render client-side from the JSON, so llms-full.txt carries the guides and worked examples but points at the JSON for exact names and shapes.

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/backend-sdk-reference.json — the generated Backend SDK reference

Next Steps

• Quick start — a client and a first call
• API Reference — the human-readable version of the JSON above