Repository navigation
Conversation
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/
This preview will be automatically updated when you push new commits to this PR. |
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the workspace script tool-call bridge: a script run by the execute workspace script tool can import
codemie_runtime_sdkand 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-jobsmode, behind thefeatures:workspaceScriptBridgesetting. 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,timeoutSecondsup to 480,maxParallelCalls), the run deadlinemax(CODE_EXECUTOR_EXECUTION_TIMEOUT, timeoutSeconds) + 60(540 seconds at the maximum), capacity,call_tool/call_tools, theToolCallErrorcodes withretryableandmay_have_run, and the sequence diagram. The earlierecho-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_BRIDGEdescription.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:retryableadded 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_COUNTin the Workflow Configuration table (maximum number of files a workflow run can start with, default 20).Testing
npm startnpm run buildsucceeds withonBrokenLinksandonBrokenAnchorsset tothrow. 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 checkpasses (typecheck + lint; commitlint runs on each commit through the commit-msg hook)<text>must be`<text>`)static/img/)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).