Toolsets¶
The full surface is 194 tools in 25 toolsets. Tools are grouped so that a
deployment exposes only what its users need; gvm-mcp --list-toolsets
prints the list below.
Selection¶
--toolsets (GVM_TOOLSETS) accepts default, all, or a comma-separated
list of toolset names. default is every toolset except identity, which is
always opt-in. --read-only (GVM_READ_ONLY=true) additionally removes every
mutating tool from the server; clients do not see them at all.
gvm-mcp # default selection
gvm-mcp --read-only # reads only
gvm-mcp --toolsets targets,tasks,reports # scoped surface
gvm-mcp --toolsets default,identity # include user administration
Selection |
Tools |
|---|---|
|
171 |
|
89 |
|
194 |
|
99 |
The system toolset (connection test, version, timezones) is always present.
Reference¶
Every tool of every toolset, with its parameters, is listed in the generated Tool reference.
Toolset |
Scope |
|---|---|
|
Connectivity, health, version and timezone information |
|
Scan targets, OCI image targets and web application targets |
|
Scan tasks and their lifecycle (start, stop, resume, clone) |
|
Scan configurations, NVT and family selection, preferences, generic configs |
|
Scanner instances |
|
Scan schedules |
|
Authenticated-scan credentials and credential stores |
|
Alerts and notifications |
|
Port lists |
|
Individual scan results |
|
Reports, drill-down pages, imports and asynchronous exports |
|
Host, operating-system and generic assets |
|
TLS certificates discovered by scans |
|
Report formats |
|
Saved filters |
|
Tags on resources |
|
Notes on results |
|
Severity overrides |
|
NVTs and NVT families |
|
CVE, CPE, CERT-Bund and DFN-CERT catalogs |
|
Vulnerability listing |
|
Feed status |
|
Compliance audits and policies |
|
Sensor agents and agent groups |
|
Users, groups, roles, permissions and user settings (opt-in) |
Read-only mode¶
A tool is mutating when it creates, updates, deletes or clones a resource,
starts, stops or resumes a task or audit, writes a scan-configuration
selection or preference, imports a report, verifies a credential store or
triggers an agent sync. Every such tool is marked as mutating (and, where
applicable, destructive) in its MCP metadata, which is what --read-only
removes and what clients use to ask for confirmation.
Tool conventions¶
Names follow
openvas_<verb>_<resource>, for exampleopenvas_list_tasks,openvas_get_report,openvas_create_target.List tools return summarized rows plus a pagination envelope. Use the matching
openvas_get_*tool for the full record. Filter and pagination arguments are described in usage.md.Delete tools move resources to the trashcan unless
ultimate: trueis passed; resources without a trashcan take only anid.
Availability notes¶
identityis never part ofdefault; add it explicitly.Tickets are not exposed by the gateway.
OCI image targets, web application targets, agents and credential stores depend on the connected gvmd build having those features enabled. Without them the gateway’s problem response surfaces as a legible tool error.