Skip to content

docs: tool and host API changes, 8–15 Oct - #1090

Merged
Aymericr merged 5 commits into
mainfrom
cursor/docs-tool-host-api-oct-af6f
Oct 15, 2026
Merged

Aymericr merged 5 commits into
mainfrom
cursor/docs-tool-host-api-oct-af6f

Conversation

@Aymericr

@Aymericr Aymericr commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

What does this PR do?

Docs only, no code changes. It brings the docs up to date with what merged between 8 and 15 Oct. Several of those PRs had already updated the MCP README, the skills and the wiki, so this PR fills the gaps that were left. Each one was checked against the source PR and the current contracts.

MCP / tool reference (packages/mcp/README.md, packages/mcp/CHANGELOG.md)

  • Rows that were stale before this PR:
    • create_roof: roofType: "barrel", roofSystem, glazing, barrelRise, barrelSegments, wallThickness.
    • paint: the glazing-frame / glazing-glass / glazing-solid roles.
    • view_scene: the 1920 × 1200 default, maxPx from 64 to 1920, the camera_and_viewpoint refusal.
    • apply_patch: roof seating notes and the roof_level, roof_level_holds_storey and roof_level_on_top refusals.
  • New: a units-and-pitch paragraph with an example ("9 ft", "18 in", "6:12", and which forms are refused).
  • New: a before/after block for the retired tools (find_by_type, get_node, verify_scene).
  • New: an examples block covering get_site, L-shaped and no-level stairs, a glazed barrel roof, gableOverhang, search_materials + paint, and view_scene.
  • New: "Plugin tools and the person's floor", with a registerOperationTool + createSceneOperations({ activeLevelId }) example.
  • New: the agent guide's hosted project-context tools.
  • The MCP changelog gets Added/Changed entries, with links, for every MCP-facing change.

Host / embedding API (new packages/editor/README.md)

  • An example-first guide for embedding <Editor>: loadingSlot, actionMenuPlacement, viewBar, sceneOverlay and stageOverlay.
  • Theming: following the host's .dark class, with InterfaceThemeRow in SettingsPanel's preferences slot.
  • Views: registerEditorHostView, openEditorView, PLUGINS_VIEW_ID.
  • Selection: selectZoneOrRoom, frameViewerNode, enterUnitFocus, and pointed-at highlighting.
  • Plugin chat start screens, and IconRefGlyph / IconRefImage.
  • Linked from the root README's "Using Published Packages".

Self-hosting

  • Checked the README's "Self-host it" section against the Dockerfile, docker-compose.yml, the release workflow and SETUP.md. It matches: ghcr.io/pascalorg/pascal-editor, port 3000, the /data volume, PASCAL_PUBLIC_URL read at runtime, PASCAL_ADMIN_PASSWORD, and latest for stable releases. No change was needed.
  • No doc still mentions NEXT_PUBLIC_APP_URL or MINT_PASCAL_HOST_ORIGIN.

Blender guide (new wiki/blender-geometry-scripts.md)

  • The committed cabinet fixture as a worked bpy module, then the add_object call that builds it.
  • The module shape, a table of the conventions in Blender terms, editing and reading back, and where bpy runs (editor builder, PASCAL_BLENDER, @pascal-app/geometry-script/blender*).
  • Linked from authored-objects.md and the MCP README.

Release process

  • The root README's "Publishing Packages" said seven packages and left out geometry-script. It now lists eight, with the npm-existence preflight and the deploy-key push.
  • CONTRIBUTING.md gets a short "Releases" section: adding a package needs a first publish by hand, and the RELEASE_DEPLOY_KEY must stay in the ruleset's bypass list. wiki/npm-release.md already covered both, so it is unchanged.

Root CHANGELOG.md

  • Unreleased Features, Breaking (the retired MCP tools, no more forced dark chrome, deprecated viewMode) and Release process entries, each linked to its PR. PR links are also added to the existing view_scene, self-hosting and embed entries.

Source PRs

How to test

  1. Read packages/mcp/README.md "Tools": the create_roof, paint, view_scene and apply_patch rows, the notation paragraph and the Examples block should match packages/core/src/agent-tools/{roofs,paint,view-scene,stairs}.ts.
  2. Read packages/editor/README.md: every prop and export it names should exist in packages/editor/src/components/editor/index.tsx and packages/editor/src/index.tsx.
  3. Read wiki/blender-geometry-scripts.md: its module should match packages/geometry-script/src/__fixtures__/blender/cabinet.py.
  4. bun run skills:validate passes (69 tests) and bun run check reports no errors; I ran both. Every relative link and anchor in the changed files resolves.

Screenshots / screen recording

N/A — non-visual change

Checklist

  • I've tested this locally with bun dev
  • My code follows the existing code style (run bun check to verify)
  • I've updated relevant documentation (if applicable)
  • This PR targets the main branch
Open in Web Open in Cursor 

Note

Low Risk
Markdown and changelog updates only; no application logic, APIs, or build behavior change in this PR.

Reviewed by Cursor Bugbot for commit b1c8321. Bugbot is set up for automated code reviews on this repo. Configure here.

@Aymericr
Aymericr marked this pull request as ready for review October 15, 2026 17:01
@Aymericr
Aymericr merged commit 978ab6c into main Oct 15, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants