Update MCP documentation - #15987
Draft
mtesauro wants to merge 1 commit into
Draft
Update MCP documentation#15987mtesauro wants to merge 1 commit into
mtesauro wants to merge 1 commit into
Conversation
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.
Description
Documentation-only change to the Pro MCP Server page,
docs/content/metrics_reports/ai/mcp_server_pro.md(published at/metrics_reports/ai/mcp_server_pro/). No code, settings, or migrations.The next DefectDojo Pro patch release ships the multi-toolset MCP Server: the existing
/mcpendpoint is unchanged, and add-on toolsets are selected with atoolsetsquery parameter and switched on per instance under Settings → Feature Flags. This PR documents that release and, while in the file, fixes the tool reference, which had drifted from what the server actually serves.New content:
coreis (everything/mcphas always served), how add-on toolsets are enabled (the MCP: Asset Hierarchy flag, which also needs the Asset Hierarchy feature), and that a toolset flag only changes what the MCP Server offers, never the REST API or the connecting token's permissions./mcp,/mcp?toolsets=hierarchy,/mcp?toolsets=all, with the note thatallneeds theAuthorizationheader at connect time; theget_instance_infotool that reports version, enabled toolsets, flag states, and the Asset/Organization vs Product/Product Type naming; where the query string goes for each client type.400/401/403/503plain-text responses, what each means, and what to do; plus behaviour when a flag is turned off mid-session.toolset '<name>' is not enabled on this DefectDojo Pro instance.Corrections to existing content:
coretoolset serves 18 tools, 6 resources, and 2 prompts (19 tools when the URL carries atoolsetsparameter, becauseget_instance_infois added). Both places now agree.get_product_by_id,get_product_type_by_id,get_engagement_by_id,get_test_by_id, with a note on walking Finding → Test → Engagement → Asset → Organization with direct calls.get_products" are spelled out per tool:get_products(name,business_criticality,platform,lifecycle,external_audience,internet_accessible),get_engagements(product_id),get_tests(engagement_id),get_users(username,email,is_active,is_superuser),get_groups(name);get_product_typesandget_rolestakelimit/offsetonly.get_dojo_group_members.group_idwas documented as required; it is optional, anduser_idis also accepted, so the tool can list a user's groups as well as a group's members.limit(1–1000, default 100) /offset(min 0) arguments and the single required ID on every*_by_idtool.Terminology follows the page's existing convention of Asset / Organization as the primary names.
Test results
Docs-only; no unit tests apply. Verified by rendering the site locally from
docs/:Build exits 0 and the page renders with the new sections, tables, and
<details>blocks; existing anchors are unchanged and the new in-page link[Toolsets](#toolsets)resolves. Local Hugo was 0.163.x versus the 0.153.4 pinned in CI; the only warnings were pre-existing theme deprecation notices unrelated to this page.The counts, tool names, argument names, ranges, and error texts were taken from the MCP Server build that ships with the same Pro patch release, and checked against a live Pro instance running that build (
tools/liston/mcpand/mcp?toolsets=core, and each rejection status by connecting with an invalid selection).Documentation
This PR is the documentation change. It is paired with a DefectDojo Pro change on the Pro
bugfixline; both ship in the same patch release, which is why this targetsbugfixrather thandev.Checklist
bugfix.docsapplied.