get-provider-details

Retrieve detailed information about OpenTofu providers by specifying namespace and name to understand capabilities and requirements.

Instructions

Get detailed information about a specific OpenTofu provider by namespace and name. Do NOT include 'terraform-provider-' prefix in the name.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`namespace`	Yes	Provider namespace (e.g., 'hashicorp', 'opentofu')
`name`	Yes	Provider name WITHOUT 'terraform-provider-' prefix (e.g., 'aws', 'kubernetes', 'azurerm')

Implementation Reference

src/servers/registry/index.ts:91-99 (handler)

MCP tool handler: fetches provider details using RegistryClient, renders with renderProviderDetails, handles errors.

async (params) => {
  try {
    const provider = await client.getProviderDetails(params.namespace, params.name);
    return textResult(renderProviderDetails(params.name, params.namespace, provider));
  } catch (error: unknown) {
    const errorMessage = error instanceof Error ? error.message : "Provider not found";
    return textResult(`Failed to get details for provider ${params.namespace}/${params.name}: ${errorMessage}`);
  }
},

src/servers/registry/index.ts:12-15 (schema)

Input schema defining namespace and name parameters with Zod validation and descriptions.

const providerDetailsSchema = {
  namespace: z.string().min(1).describe("Provider namespace (e.g., 'hashicorp', 'opentofu')"),
  name: z.string().min(1).describe("Provider name WITHOUT 'terraform-provider-' prefix (e.g., 'aws', 'kubernetes', 'azurerm')"),
};

src/servers/registry/index.ts:87-100 (registration)

Registers the 'get-provider-details' tool with MCP server, providing name, description, schema, and handler.

server.tool(
  "get-provider-details",
  "Get detailed information about a specific OpenTofu provider by namespace and name. Do NOT include 'terraform-provider-' prefix in the name.",
  providerDetailsSchema,
  async (params) => {
    try {
      const provider = await client.getProviderDetails(params.namespace, params.name);
      return textResult(renderProviderDetails(params.name, params.namespace, provider));
    } catch (error: unknown) {
      const errorMessage = error instanceof Error ? error.message : "Provider not found";
      return textResult(`Failed to get details for provider ${params.namespace}/${params.name}: ${errorMessage}`);
    }
  },
);

src/registry/index.ts:92-107 (helper)

RegistryClient method implementing the core logic: fetches provider index, determines and fetches latest version details from OpenTofu API.

async getProviderDetails(namespace: string, name: string): Promise<ProviderWithLatestVersion> {
  const path = `/registry/docs/providers/${namespace}/${name}/index.json`;
  const provider = await this.fetchFromApi<apiDefinition["Provider"]>(path);

  const enhancedProvider: ProviderWithLatestVersion = { ...provider };

  if (provider.versions?.length > 0) {
    const latestVersion = this.getLatestVersion(provider.versions);

    const versionPath = `/registry/docs/providers/${namespace}/${name}/${latestVersion}/index.json`;
    const versionDetails = await this.fetchFromApi<apiDefinition["ProviderVersion"]>(versionPath);
    enhancedProvider.latestVersion = versionDetails;
  }

  return enhancedProvider;
}

src/servers/registry/render.ts:6-29 (helper)

Helper function to format and render the provider details into markdown text for the tool response.

export function renderProviderDetails(name: string, namespace: string, provider: ProviderWithLatestVersion): string {
  let formattedResponse = `## Provider: ${provider.addr.display}\n
${provider.description}

**Latest Version**: ${provider.versions[0]?.id || "Unknown"}
**All Versions**: ${provider.versions.map((v) => v.id).join(", ")}

**Popularity Score**: ${provider.popularity}
${provider.link ? `\n**Documentation**: ${provider.link}\n` : ""}`;

  if (provider.latestVersion) {
    const v = provider.latestVersion;
    formattedResponse += `\n## Latest Version Details (${v.id})\n`;

    if (v.docs?.resources) {
      formattedResponse += `\n${renderResourcesSection(v.docs.resources, name, namespace)}\n`;
    }

    if (v.docs?.datasources) {
      formattedResponse += `\n${renderDataSourcesSection(v.docs.datasources, name, namespace)}\n`;
    }
  }
  return formattedResponse;
}

OpenTofu MCP Server