You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A Model Context Protocol (MCP) server that provides comprehensive Terraform module context for IBM Cloud architectures. This MCP server enhances the TIM Designer backend by bridging the gap between module discovery and implementation, enabling more accurate and context-aware Terraform code generation.
8
+
A [Model Context Protocol (MCP) server](https://modelcontextprotocol.io/docs/getting-started/intro) that provides structured access to the Terraform IBM Modules (TIM) ecosystem. TIM is a curated collection of IBM Cloud Terraform modules designed to follow best practices.
9
+
10
+
This server acts as a bridge, enabling AI models and other tools to intelligently discover and utilize the extensive documentation, examples, and implementation patterns bundled with the [TIM modules](https://github.com/terraform-ibm-modules). It is designed to support AI-assisted coding workflows for creating IBM Cloud infrastructure.
11
+
12
+
**About TIM:**[Terraform IBM Modules (TIM)](https://github.com/terraform-ibm-modules) is a collection of curated IBM Cloud Terraform modules available on the [Terraform Registry](https://registry.terraform.io/namespaces/terraform-ibm-modules). Full documentation is available at https://github.com/terraform-ibm-modules/documentation.
8
13
9
14
## Quick Start
10
15
@@ -54,25 +59,33 @@ Get started with TIM-MCP in Claude Desktop in under 2 minutes:
54
59
55
60
## Overview
56
61
57
-
TIM-MCP combines data from the HashiCorp Terraform Registry with actual implementation details from GitHub repositories to provide rich context about IBM Cloud Terraform modules. While existing tools can search for modules and retrieve basic metadata, they lack access to real implementation code, working examples, and detailed integration patterns that are essential for generating production-ready Terraform configurations.
62
+
This MCP server provides tools for AI models to navigate the [Terraform IBM Modules (TIM)](https://github.com/terraform-ibm-modules) ecosystem. TIM modules are bundled with extensive documentation, working examples, and architectural patterns, but these resources are distributed across many GitHub repositories.
58
63
59
-
## Installation
64
+
This server exposes a set of tools that allow an AI assistant to:
65
+
-**Discover** relevant modules from the [Terraform Registry](https://registry.terraform.io/namespaces/terraform-ibm-modules).
66
+
-**Inspect** module details, including inputs, outputs, and dependencies.
67
+
-**Explore** the contents of a module's repository, such as examples and submodules.
68
+
-**Retrieve** specific file contents, like example code or documentation.
60
69
61
-
TIM-MCP requires Python 3.11 or higher and uses [uv](https://docs.astral.sh/uv/) for dependency management.
70
+
The goal is to provide a structured and efficient way for an AI to gather the necessary context to generate accurate and high-quality Infrastructure as Code solutions for IBM Cloud.
-**Module Search**: Find modules in the Terraform Registry with quality-based ranking.
75
+
-**Module Details**: Get structured information about a module's interface.
76
+
-**Repository Exploration**: List the contents of a module's repository, including examples and submodules.
77
+
-**Content Retrieval**: Fetch specific files from a module's repository.
78
+
-**AI-Assisted Workflows**: The tools are designed to be used in sequence to support a typical AI-assisted coding workflow.
72
79
73
-
##Development Setup
80
+
### Important Notes
74
81
75
-
To set up the development environment:
82
+
⚠️ **Experimental Status**: This MCP server and the solutions it helps generate are experimental. Generated configurations should always be reviewed by skilled practitioners before use in any environment.
83
+
84
+
⚠️ **Human Review Required**: Even when the tools and workflows mature, human expertise will remain essential for reviewing outputs, making final adjustments, and ensuring configurations meet specific requirements.
85
+
86
+
## Development Installation
87
+
88
+
For developers who want to contribute to TIM-MCP or run it locally for development purposes:
76
89
77
90
```bash
78
91
# Clone the repository
@@ -89,6 +102,12 @@ uv run pytest
89
102
uv run tim-mcp
90
103
```
91
104
105
+
**Requirements:**
106
+
- Python 3.11 or higher
107
+
-[uv](https://docs.astral.sh/uv/) package manager
108
+
109
+
> **Note:** For most users, we recommend using the Quick Start guide above rather than installing locally. The Quick Start method automatically handles dependencies and is easier to maintain.
110
+
92
111
## Transport Modes
93
112
94
113
TIM-MCP supports two transport modes for different deployment scenarios:
0 commit comments