Skip to main content
Glama

Get one NetActuate docs page in full

get_netactuate_doc
Read-only

Returns one page of NetActuate's technical documentation (netactuate.com/docs) in full: how-to guides (cloud-init, Terraform, Ansible, Kubernetes, BGP and anycast, firewalls, load balancers, Secrets Manager, storage), product and platform reference pages, and each marketplace appliance's setup page. Gives the page's description and its body in order, headings marked '## ' and code blocks fenced, with its URL, and the marketplace listing for an appliance page. Accepts a URL or path from search_netactuate, a marketplace listing's docsUrl, or a page title such as 'Building VMs with Cloud-Init'. A title matching several pages returns up to ten candidates rather than a guess; a page longer than the server keeps is cut, with a note. An API reference page returns its endpoint instead of a body: to find endpoints, use find_api_endpoints. For marketing pages, get_netactuate_page.

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": {
      "doc": "<doc>"
    },
    "name": "get_netactuate_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
docYesA docs URL or path (e.g. 'https://netactuate.com/docs/guides/building-with-cloud-init', 'networking/bgp'), or a page title (e.g. 'Terraform Provider v2').

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / doc / description
      Previous value: -"A docs URL or path (e.g. 'https://netactuate.com/docs/guides/building-with-cloud-init', 'networking/bgp'), or a page title (e.g. 'Terraform Provider v2 Setup')."New value: +"A docs URL or path (e.g. 'https://netactuate.com/docs/guides/building-with-cloud-init', 'networking/bgp'), or a page title (e.g. 'Terraform Provider v2')."
  2. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. Changed1 schema field changed
    • changedInput schema / properties / doc / maxLength
      Previous value: -200New value: +400
  4. Changed1 schema field changed
    • removedInput schema / additionalProperties
      Removed value: -false
  5. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only cover the safety profile (readOnly, non-destructive, closed world); the description adds real behavioral context beyond them: ambiguous titles return up to ten candidates instead of guessing, oversized pages are truncated with a note, and API reference pages return an endpoint rather than a body. That pre-empts the three most likely surprises an agent would hit.

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

Conciseness4/5

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

Purpose is front-loaded in the first clause and each subsequent sentence adds a distinct fact (output shape, input forms, ambiguity handling, truncation, two sibling routings). It runs long as a single dense paragraph, which slightly hurts scannability, but there is essentially no waste.

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

Completeness5/5

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

No output schema exists, so the description carries the full burden of describing return values, and it does: description plus body in order, headings marked '## ', fenced code blocks, URL, and the marketplace listing for appliance pages. Combined with ambiguity and truncation behavior, an agent has everything needed to call this and interpret the result.

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

Parameters4/5

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

Schema coverage is 100% and the single param already has examples, so the baseline is 3. The description earns a bump by restating the three distinct input shapes the one `doc` field accepts and confirming title-based lookup is supported, which clarifies semantics the schema's example list only implies.

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

Purpose5/5

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

Opens with a specific verb and resource ('Returns one page of NetActuate's technical documentation in full') and immediately enumerates the content classes it covers, so an agent knows exactly what it fetches. It also distinguishes itself from siblings by name (find_api_endpoints, get_netactuate_page, search_netactuate) rather than leaving routing to inference.

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

Usage Guidelines5/5

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

Explicitly states the three acceptable input forms (URL/path from search_netactuate, a marketplace listing's docsUrl, or a page title) and names the alternatives for the two boundary cases: 'to find endpoints, use find_api_endpoints' and 'For marketing pages, get_netactuate_page.' When/when-not guidance is fully spelled out.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources