Vinyasa DocsOpen editor

AI Copilot: Providers, Context, and Reviewed Edits

Set up Gemini, OpenAI, Anthropic, or local models for Vinyasa; configure context limits, inspect bounded document slices, and review AI proposals before applying.

Introduction

Open hosted Studio at /editor. The website is / and documentation starts at /docs/vinyasa/overview/. No Vinyasa installation or local server is required.

Vinyasa supports three distinct AI workflows: built-in Copilot sends bounded inspection requests directly from your browser to a configured AI provider server; external chat assistants use the downloaded reference to return document YAML; MCP agents connect to the hosted document tools at /mcp. MCP does not supply an AI model and its public endpoint needs no provider key. All workflows share document validation and the element catalog. AI proposes changes; it does not certify a design or automatically change your canvas. Use synthetic content and review the data flow before sending a draft.

External assistants and MCP coding agents

For ChatGPT, Claude, Copilot, or another external assistant, attach vinyasa-document-reference.md from Help > Download Syntax Ref. It contains complete document and .rvv envelope examples, page/settings fields, common properties, frame/group nesting, coordinate rules, validation limits, production URLs and generated property constraints. Ask for bare document YAML with schemaVersion, elements, pages and settings, explicit stable IDs, and no invented CSS fields. Paste the result into the YAML tab, validate, inspect it, and choose Apply to canvas. A bare document is not an importable .rvv project envelope.

For a tool-aware agent, connect Streamable HTTP to /mcp. The hosted server exposes list_elements, get_element_schema, validate_document, edit_document, and export_project. It requires no token or OAuth; it is unrelated to your AI provider key. Follow the MCP guide for VS Code/Claude Code configuration, exact tool arguments, response extraction, and troubleshooting. Tools process supplied documents; they cannot read browser projects or apply changes to your canvas. Your client controls approvals and may send results to its provider.

Context-aware editing and failure handling

The built-in agent starts from counts, type names, and a bounded page overview rather than sending all YAML. It searches summaries, reads selected properties by ID, and asks for schemas as needed. Each turn retains a short plan and the latest inspection instead of an ever-growing transcript. Updates merge locally, preserving untouched properties.

Generation is capped at ten requests, with a 60-second timeout per request and 4,096 output tokens. Input is conservatively budgeted; oversized prompts or inspections fail explicitly. Unread-element edits and invalid properties are rejected, not applied or rerouted to another provider. Large text fields may require direct YAML editing. Read large-document limits before requesting a broad redesign.

For external prompts, ask for stable IDs, explicit left/top positions, supported properties, synthetic records, and validation before presentation. Both frame and user-group support children; windows and cards are visual elements, not implicit containers. Top-level coordinates are workspace-relative, while child coordinates are container-local. pageId is ownership metadata, not a position offset.

Exact provider endpoints and credentials

Provider API base URL entered in configuration Request route Initial model preset
Google Gemini https://generativelanguage.googleapis.com/v1beta /models/{model}:generateContent gemini-2.5-flash
OpenAI https://api.openai.com/v1 /chat/completions gpt-4.1-mini
Anthropic https://api.anthropic.com/v1 /messages claude-sonnet-4-5
OpenAI-compatible server Your provider's documented HTTPS API base /chat/completions Exact model identifier served by that provider

These are implementation presets, not promises of current availability or account access. Verify your provider's supported model ID and billing. Enter the base URL, not an already-completed request path, to avoid duplicated routes. Gemini uses x-goog-api-key; Anthropic uses x-api-key plus its version and direct-browser-access headers; OpenAI/compatible uses Bearer authorization when a key is supplied. Managed providers require a nonempty key; compatible endpoints follow their server's authentication rules. Never put keys in endpoint URLs, documents, screenshots, Git or MCP configuration.

Gemini must return completed JSON; OpenAI/compatible must support JSON-object output and a completed chat choice; Anthropic must return the forced vinyasa_action tool result. Arbitrary text or fenced YAML is not the built-in agent protocol. Use HTTPS provider servers; URLs containing embedded credentials, query strings or fragments are rejected. Requests run directly in the browser, so the provider must permit the hosted Vinyasa origin. There is no hosted proxy or automatic fallback. See compatible server requirements.

Diagnose generation and apply failures

Symptom What to check
Save configuration succeeds but generation fails Save only keeps settings in tab memory; Generate proposal makes the network request.
401 / 403 from provider Key validity, model/account permission and browser-access policy; do not paste secrets into a bug report.
404 from provider API base URL and exact model ID; do not append the request route yourself.
429 Provider quota/rate limits; inspect billing and retry deliberately.
Browser CORS / network error Whether the provider permits browser requests from ; local services must permit that exact origin.
Invalid JSON / wrong completion reason The endpoint/model must implement the selected provider protocol; changing the URL alone cannot add JSON/tool support.
Context budget / timeout / request limit Use the actual runtime context setting and request one bounded change; read the large-document guide.
Unknown fields or element IDs Inspect supported schemas, reload the current draft and preserve normalized IDs.
Stale proposal Reload the changed canvas/draft before generating again; never overwrite newer work blindly.

Cancel aborts active and subsequent requests but cannot recall already-sent data or provider charges. Errors and discarded proposals leave the applied canvas unchanged. Export an .rvv backup before major changes. Use MCP troubleshooting for external agent transport problems, not the provider settings above.

Prompt recipes and choosing the right tool

Try a focused request such as: "Find the billing screen's Save button. Keep its ID, text, size, and color; move it 16 pixels down. Do not modify other screens." For new layouts, specify screen size, controls, spacing, and the intended audience. Review the prompt recipes and login demo.

Vinyasa produces prototypes, not production applications. If the next step is shared design-system work or a code-backed application, consult the tool comparisons rather than assuming one workflow replaces all others.

Open Vinyasa editor