Repository navigation
[PLT-1116] docs: add Tool Recommendation section under MCP Gateways - #1204
Open
itsthatriver wants to merge 3 commits into
Open
itsthatriver wants to merge 3 commits into
itsthatriver wants to merge 3 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
itsthatriver
force-pushed
the
river/plt-1116-tool-recommendation-docs
branch
from
October 5, 2026 21:01
e6a17cf to
629e357
Compare
Three new customer-facing pages under Operate > Governance > MCP Gateways > Tool Recommendation: - Overview (how it works): the Arcade tools an MCP client sees (SelectTools, UseTool, ListApps; SearchTools callable but unlisted), the select-then-use flow, semantic selection vs BM25 keyword search, allowlist scoping, and why tool descriptions drive quality. - Configure: the per-gateway dashboard toggle and PATCH API, the PUT reset pitfall, allowlist interaction, per-connection URL opt-outs, and what callers get when it is off. - When not to use it: small gateways, fixed-workflow agents, thin descriptions, and limits (remote MCP server tool lists are read at registration and not refreshed on a schedule; background indexing delay; five results per task). Behavior verified against the monorepo engine, dashboard, and Condex code. Also links the section from the MCP Gateways overview and nav. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
itsthatriver
force-pushed
the
river/plt-1116-tool-recommendation-docs
branch
from
October 8, 2026 00:10
b7fd77c to
0e1cd39
Compare
…PLT-1116) - tools/list on a Tool Recommendation gateway returns only the Arcade tools; recommended tools are not echoed into later listings (PLT-4127). UseTool admits a tool by the allowed list plus governance rules, not by prior selection. - Document the per-task empty_reason (no_match / unavailable) an agent gets when a task has no tools, and never a "degraded" marker (PLT-3553). - Limitations: a remote MCP server's tool list is also re-read when an OAuth server is authorized; still no refresh cadence (PLT-3580 canceled). - Vale: fix new Anthropomorphism and Passive findings. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch was successfully 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
Adds a new Tool Recommendation section under Operate → Governance → MCP Gateways, with three customer-facing pages and a link from the MCP Gateways overview. Tracks PLT-1116.
/operate/governance/mcp-gateways/tool-recommendationSelectTools,UseTool,ListApps;SearchToolscallable but unlisted), the select-then-use flow, semantic selection vs BM25 keyword search, allowlist and Contextual Access scoping, MCP-native (no SDK changes), and why tool descriptions drive quality.../tool-recommendation/configurePATCHAPI, thePUTreset pitfall, allowlist interaction, per-connection?tool_recommendation=false/?arcade_tools=falseopt-outs, what callers get when it's off, and a check-that-it-works list.../tool-recommendation/limitationsNaming
"Tool Recommendation" is the product name throughout. "Tool Search" appears only as the name of the BM25 keyword leg (
Arcade.SearchTools).Accuracy notes for reviewers
Every behavior claim was checked against the monorepo code at
7a804fcf35(enginemcp/metatools,arcadetools/definitions.go,api/schemas/crud_gateway.go,mcp/gatewayoptions; dashboardmcp-gatewaysform; Condex embedding templates). A few points worth a second look:CatalogRefresher, GRO-377).topKand the default Condex embedding config. Both could change later.?tool_recommendation/?arcade_toolsURL parameters are documented for the first time here.What changed in this revision
Rebased onto docs
main(258b9547). Only the generatedpublic/llms.txtheader conflicted. I took main's header and kept the three new index entries.tools/listreturns only the Arcade tools, before and afterSelectTools. Matches monorepo#5240.UseToolis described as admitting a tool by the allowed list plus governance rules (Contextual Access), not by prior selection. The configure page's check-it-works step says the list stays fixed.empty_reason:no_match(retrying won't help) orunavailable(retrying may help). No page says "degraded". Matches monorepo#4459.GET /v1/apps/ RESTListAppscontent. These pages don't cover the tools REST surface, and #5159 is still in review.Merge order: the
empty_reasonparagraph and the fixed-tool-list wording describe monorepo#4459 and #5240, which are both open. Ship this page after they deploy, or the docs will run ahead of the product for a while.Verification
vale3.14.2 (CI's pinned version), withvale sync, run on each changed page as Markdown (vale --ext=.md --output=line < page.mdx). The two findings this revision introduced (Anthropomorphism, Passive) are fixed. What's left is expected:Google.Headingson the product name "Tool Recommendation", andGoogle.Semicolonson the MDXimportline, which only appears because MDX is linted as Markdown (the MCP Gateways overview onmaingets the same flag). The lines added to the MCP Gateways overview have no findings.pnpm install --frozen-lockfile && pnpm run lint && pnpm run typecheck: all pass.pnpm build. The nav and_meta.tsxare unchanged since the earlier build.~ Δ Delta, downstream of River
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes with no runtime, API, or application code modifications.
Overview
Adds customer-facing Tool Recommendation documentation under Operate → Governance → MCP Gateways, with navigation updates and a new overview link on the MCP Gateways page.
The new section includes an overview (select-then-use flow via
Arcade.SelectTools/Arcade.UseTool, semantic vs keyword search, allowlist and Contextual Access), a Configure page (dashboard toggle,tool_filter.discovery.enabledviaPATCH,PUTpitfalls, per-connection URL opt-outs), and When not to use it (small gateways, fixed workflows, description quality, operational limits).public/llms.txtis updated so agents can discover the new routes.Reviewed by Cursor Bugbot for commit 657034f. Bugbot is set up for automated code reviews on this repo. Configure here.
Closes PLT-1116