Skip to content

docs(config): document the workspace script tool-call bridge - #448

Open
yanaSelin wants to merge 5 commits into
mainfrom
docs/EPMCDME-15401-workspace-script-bridge
Open

yanaSelin wants to merge 5 commits into
mainfrom
docs/EPMCDME-15401-workspace-script-bridge

Conversation

@yanaSelin

@yanaSelin yanaSelin commented Sep 30, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Documents the workspace script tool-call bridge: a script run by the execute workspace script tool can import codemie_runtime_sdk and call CodeMie tools while it runs (call_tool, call_tools). Covers the administrator settings and limits, and adds a user-guide page for script authors. Ticket: EPMCDME-15401.

The PR also documents running a script from a workflow step (a Tool node with the workspace script tool, scripts attached when a run starts). Ticket: EPMCDME-15559.

Calling tools from scripts is now available in sandbox-jobs mode, behind the features:workspaceScriptBridge setting. Only tools that are opted in can be called, and only those in the run's tool list.

Changes

  • code-executor-configuration.md: "Workspace Script Tool-Call Bridge" section rewritten. Covers enabling the bridge (enabled, timeoutSeconds up to 480, maxParallelCalls), the run deadline max(CODE_EXECUTOR_EXECUTION_TIMEOUT, timeoutSeconds) + 60 (540 seconds at the maximum), capacity, call_tool/call_tools, the ToolCallError codes with retryable and may_have_run, and the sequence diagram. The earlier echo-only text is removed.
  • customer-feature-configuration.md: component row, YAML block (cap 480, maxParallelCalls), full-example entry.
  • dynamic-customer-configuration.md: row in Available Dynamic Settings.
  • api-configuration.md: FEATURE_WORKSPACE_SCRIPT_BRIDGE description.
  • FAQ, runtime customer configuration answer: lists the dynamic component.
  • New page user-guide/tools_integrations/tools/workspace-script-sdk.md: who can call which tools, call_tool/call_tools, result envelope, errors, limits. Added to the Tools sidebar and the tools overview table.
  • cspell.config.yaml: retryable added to the word list.
  • workspace-script-sdk.md: new section "Running a Script from a Workflow Step": how to set up the step, what the execution results show, and how the step output and created files reach the next steps.
  • workflows-overview.md: the "How files are available in workflow steps" part now says attached files are also placed in the run's workspace, so a Tool node can run an attached script, and that only files the user has access to can be attached.
  • api-configuration.md: WORKFLOW_RUN_FILES_MAX_COUNT in the Workflow Configuration table (maximum number of files a workflow run can start with, default 20).

Testing

  • Tested locally with npm start
  • All pages render correctly
  • Images display properly
  • Internal links work
  • Sidebar navigation works

npm run build succeeds with onBrokenLinks and onBrokenAnchors set to throw. The pages were not opened in a browser, so the rendered pages, the new sidebar entry, and the mermaid diagram were not checked visually.

Quality Checks

  • npm run check passes (typecheck + lint; commitlint runs on each commit through the commit-msg hook)
  • No MDX compilation errors
  • No raw angle brackets (<text> must be `<text>`)
  • Sidebar references document IDs (not filenames)
  • Images stored locally next to content (not in static/img/)
  • Commit messages follow Conventional Commits
  • No secrets or credentials in documentation

Additional Notes

The feature is not part of the Enterprise package, so no Enterprise markers are added. The new user-guide page is added to sidebars.ts (Integrations and Tools → Tools), so the sidebar changes in this PR.

The workflow-step section was checked against the backend change of EPMCDME-15559 (codemie MR !4426) and a local run: a script attached at run start ran in a Tool node, the output and files reached the next step, a missing or failing script failed the step.

The limits and error codes were checked against the implementation (SDK constants, the normalize_* clamps, the deadline buffer, the customer-config declarations).

@github-actions

Copy link
Copy Markdown

PR Preview Ready!

Your preview documentation is ready! Visit it here:

Preview URL: http://codemie-docs-pr-previews.s3-website.eu-central-1.amazonaws.com/pr-448/

Note: This preview URL is accessible only while connected to the company VPN.


This preview will be automatically updated when you push new commits to this PR.
Preview files will be deleted when the PR is closed or merged.

yanaSelin and others added 4 commits October 6, 2026 11:50
Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>
Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>
Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>

This branch has not been deployed

No deployments
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.

1 participant