Skip to main content
Glama
Sign In
OpenTofu MCP Server

OpenTofu MCP Server

Official
by opentofu
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get-module-details

Retrieve detailed information about an OpenTofu module by specifying its namespace, simple module name, and target platform.

Instructions

Get detailed information about a specific OpenTofu module by namespace, name, and target. Use the simple module name, NOT the full repository name.

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": {
      "namespace": "<namespace>",
      "name": "<name>",
      "target": "<target>"
    },
    "name": "get-module-details"
  }
}

Input Schema

NameRequiredDescriptionDefault
namespaceYesModule namespace without prefix (e.g., 'terraform-aws-modules')
nameYesSimple module name WITHOUT 'terraform-aws-' or similar prefix (e.g., 'vpc', 's3-bucket')
targetYesModule target platform (e.g., 'aws', 'kubernetes', 'azurerm')

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.4
    • removedInput schema / additionalProperties
      Removed value: -false
  2. First observed

TDQS

A3.6/5.0
Behavior2/5

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

No annotations are provided, and the description only says 'get detailed information', implying a read operation but without explicit details on side effects, permissions, or rate limits. This is insufficient disclosure for a tool with no annotations.

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?

Two concise sentences with no wasted words. The most important information is front-loaded.

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

Completeness2/5

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

No output schema is provided, and the description does not describe what 'detailed information' includes, leaving the agent without a clear expectation of the return structure.

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?

Input schema has 100% coverage with descriptions for all three parameters. The description reinforces the 'simple module name' rule, adding marginal value beyond the schema.

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?

The description clearly states the tool retrieves detailed information about an OpenTofu module using namespace, name, and target. It distinguishes from sibling tools which focus on datasource docs, provider details, etc.

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

Usage Guidelines4/5

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

The description explicitly instructs to use the simple module name, not the full repository name, which helps prevent errors. However, it does not explicitly compare to sibling tools or state when to use this tool over others.

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

Deploy Server

Other Tools