docs: consolidate MCP run-only access + cancellation tools, fix invented tool signatures (replaces #730, #733) - #741
Draft
jordanc-relevanceai wants to merge 1 commit into
Draft
Conversation
Folds #730 and #733, plus the MCP half of #716, into one change on the post-rename integrations/mcp/mcp-server.mdx path. Corrects every tool signature against the MCP server's tool-name registry and live schemas: removes relevance_trigger_agent_async (does not exist), drops the fabricated 120-second synchronous mode, and fixes the cancellation and run_evaluation parameters. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This was referenced Jul 31, 2026
This was referenced Jul 31, 2026
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
Consolidates the two open PRs editing
integrations/mcp/mcp-server.mdx, plus the MCP half of #716, into one change — and corrects every MCP tool signature on the page against the server's own tool-name registry and live tool schemas. Branched frommain.integrations/mcp/mcp-server.mdx— OAuth consent and run-only access, roles and access levels, a rewritten execution workflow, a new Cancelling executions section, a new Running evaluations section, and an updated tool-access accordion.enterprise/rbac.mdx— Viewer row updated for MCP run-only access, personal API key row footnoted.Replaces these PRs
relevance_run_evaluationmain, not just in the source PRsThis is the part worth your attention. The page already documented an MCP tool that does not exist, and #716 would have added a table repeating it.
maindescribed two execution modes:relevance_trigger_agentas synchronous with a 120-second timeout, andrelevance_trigger_agent_asyncfor long runs. Checked againstapps/nodeapi/src/mcp/tools/tool-names.ts, the server's canonical registry:relevance_trigger_agent_async. The registry hastriggerAgent: "relevance_trigger_agent"andpollAgentResult: "relevance_poll_agent_result"and nothing else for agent triggering.relevance_trigger_agentis already asynchronous. Its schema says it "Returns immediately with a conversation_id … does NOT wait for the agent to finish."relevance_poll_agent_resulttakeswait_seconds, default 50, max 300.It appeared in four places on
main— the Execution modes tabs, the timeout Warning, the workflow steps, and a Troubleshooting accordion that told people to switch to a tool that isn't there. All four are rewritten. The "Synchronous / Asynchronous" tabs are gone, since the distinction was fictional.Also documented from the live schemas while I was in there: the real status values (
in_progress,completed,failed,pending_approval) and thehad_recoverable_tool_errorsflag with its caveat.Corrections to #730's cancellation parameters
All three were wrong, verified against the live tool schemas:
relevance_cancel_agent_tasktakesconversation_idtask_id(the value is the conversation id)relevance_cancel_workforce_tasktakestask_idworkforce_idandtask_idrelevance_cancel_tool_runtakesstudio_run_idtask_id; nostudio_run_idexists#730's behavioural claim was right and is kept: cancellation halts at the next step boundary, the in-flight step finishes, no hard abort.
Corrections to #716's
relevance_run_evaluationtableIts three-row table had every row wrong:
agent_iddoes not exist — the tool takesresource_idplusresource_type(agentorworkforce).test_set_idis not required — it is mutually exclusive withscenario_ids.evaluation_run_nameis required and was missing entirely.version_idpins the graph topology only, and nested agents still run their latest version. Documented as the caveat it is.Carried over unverified
#733's run-only behaviour — the consent-page toggle, write/delete tools being absent rather than blocked, and the Viewer API-key minting footnote — is carried over as authored. I verified the tool registry and schemas, not the OAuth consent flow, so those claims still want a second pair of eyes.
I also reworded #733's "Viewer-role users can now connect… previously only Editor-role and above could connect" to state current behaviour, since the before/after framing reads as changelog copy in reference docs.
Test plan
#oauth-consent-and-access-controlresolves fromrbac.mdx#cancelling-executionsresolves from the Troubleshooting accordiongrep -r trigger_agent_asyncreturns nothing across the repo