ansible-know-mcp

Overview Schema Source Related Servers Discussions Admin

Get Plugin Doc

get_plugin_doc

Read-only

Retrieve full structured documentation for a single Ansible plugin by name and type, including parameters, examples, and source; falls back to Galaxy when the collection is not installed locally.

Instructions

Get full structured documentation for one plugin.

Returns: plugin_name, plugin_type, short_description, params, examples, doc_source ('local' or 'galaxy'). Falls back to Galaxy if collection is not installed locally. On failure returns {"error": str}.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "plugin_name": "<plugin_name>",
      "plugin_type": "<plugin_type>"
    },
    "name": "get_plugin_doc"
  }
}

Input Schema

Name	Required	Description
`plugin_name`	Yes	Fully-qualified plugin name (e.g. 'netbox.netbox.nb_lookup')
`plugin_type`	Yes	Plugin type (lookup, filter, test, connection, become, strategy, callback, inventory, cache, cliconf, httpapi, netconf, shell, or vars)
`collection_handle`	No	Session handle returned by ensure_collection. Omit on local stdio; required on remote.

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.11.0Nov 6, 2026

addedInput schema / properties / collection_handle

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "Session handle returned by ensure_collection. Omit on local stdio; required on remote."
+}

First observedv0.7.0Jul 7, 2026

TDQS

A3.8/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already state readOnlyHint=true, so the description doesn't need to argue safety. It adds real behavior the annotations don't cover: the local-vs-Galaxy fallback when a collection isn't installed, the doc_source indicator, and the error return shape — all directly relevant to interpreting a call.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded purpose sentence, then a compact bulleted set of return fields and two behavioral notes. Nothing is padded or repeated; every line carries information an agent can use.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers purpose, fallback behavior, and failure mode; the field list is somewhat redundant since an output schema exists, and the remote-only collection_handle requirement is left entirely to the schema. Still, nothing critical is missing for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and the schema itself documents plugin_name's fully-qualified format and collection_handle's remote requirement. The description contributes no parameter-level meaning beyond that, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Get full structured documentation for one plugin.' An agent can distinguish it from search_plugins (discovery) and reasonably from get_module_doc/get_role_doc, though the description never explicitly contrasts those siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: the agent is expected to know that this is the lookup step after search_plugins, and no conditions or exclusions relative to search_docs, fetch_doc, or get_module_doc are given.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.