mirror of
https://github.com/webstudio-is/webstudio.git
synced 2026-10-30 16:47:54 +09:00
Oleg Isonen
7ff42abfb5
## Summary - Add a short introduction with the only setup step: install the Codex desktop app or Claude Desktop and ask it to install Webstudio CLI and use MCP. - Keep the existing generated reference below a divider. - Remove documentation wording assertions across generators, CLI manuals and help, MCP guidance, tool descriptions, and operation docs. - Retain structured and executable coverage for command catalogs, schemas, examples, runtime behavior, errors, and UI contracts. ## Implementation The introduction lives in the MCP page template, and the generated GitBook page is committed with it. Documentation prose is now free to change without breaking tests; tests continue to cover machine-readable contracts and observable behavior. ## Checklist - [x] Add the concise introduction to the MCP template. - [x] Regenerate the authoritative `docs/` page. - [x] Audit the repository for documentation prose assertions. - [x] Remove prose-only generator, manual, help, guidance, schema-description, and operation-description assertions. - [x] Preserve structured and executable contract coverage. - [x] Review documentation impact: the existing MCP page is updated; navigation and other documentation are unaffected. - [x] Run targeted tests, typechecks, formatting, and lint checks. ## Verification - CLI: 121 tests passed across the affected suites (119 in the sandboxed run; 2 link tests passed separately with config-directory access). - Project build: 513 tests passed. - Protocol: 23 tests passed. - Content engine reference: 1 test passed. - `pnpm docs:mcp:typecheck` - Typechecks for `webstudio`, `@webstudio-is/project-build`, and `@webstudio-is/protocol` - `oxlint --deny-warnings` on all changed TypeScript files - `oxfmt` and `git diff --check` ## Compatibility and limitations Documentation and test-only changes. No runtime behavior, schemas, fixture inputs or outputs, or external integrations are affected.
39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
---
|
||
description: >-
|
||
Connect AI agents and automation to a Webstudio Project through MCP or direct
|
||
CLI tool calls.
|
||
icon: robot
|
||
---
|
||
|
||
<!-- Generated from the local Webstudio CLI with `webstudio man mcp --verbose`. Do not edit directly. -->
|
||
|
||
# Webstudio MCP
|
||
|
||
**Webstudio MCP v{{version}}**
|
||
|
||
## Introduction
|
||
|
||
All you need to do is install the Codex desktop app or Claude Desktop and tell
|
||
it:
|
||
|
||
> Install Webstudio CLI and use MCP.
|
||
|
||
---
|
||
|
||
{% hint style="info" %}
|
||
This reference is generated from the Webstudio CLI source in the same Builder
|
||
revision. GitBook publishes it when that revision is successfully released.
|
||
Examples use an installed `webstudio` command. See [CLI](cli.md) for Node.js and
|
||
`npx` setup.
|
||
{% endhint %}
|
||
|
||
{{manual}}
|
||
|
||
## Related
|
||
|
||
- [CLI](cli.md) – Install and use the Webstudio command-line interface
|
||
- [Content Engine](foundations/content-engine.md) – Build a file-based site with Markdown and Assets queries
|
||
- [Content Engine reference](foundations/content-engine-reference.md) – Check query fields, modes, diagnostics, references, and limits
|
||
- [Share links](foundations/share-links.md) – Grant the access used to link a Project
|
||
- [Publishing and custom domains](foundations/publishing-and-custom-domains.md) – Publish the completed Project
|