Skip to content

Commit 75a92fa

Browse files
authored
docs: add rational of this mcp server + badge to readme (#8)
1 parent 5497f9d commit 75a92fa

File tree

1 file changed

+33
-14
lines changed

1 file changed

+33
-14
lines changed

README.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,13 @@
33
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
44
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
55
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
6+
[![Experimental](https://img.shields.io/badge/status-experimental-orange.svg)](#)
67

7-
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.
813

914
## Quick Start
1015

@@ -54,25 +59,33 @@ Get started with TIM-MCP in Claude Desktop in under 2 minutes:
5459

5560
## Overview
5661

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.
5863

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.
6069

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.
6271

63-
```bash
64-
# Install from PyPI (when published)
65-
uv tool install tim-mcp
72+
### Key Features
6673

67-
# Install from source
68-
git clone https://github.com/terraform-ibm-modules/tim-mcp.git
69-
cd tim-mcp
70-
uv sync
71-
```
74+
- **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.
7279

73-
## Development Setup
80+
### Important Notes
7481

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:
7689

7790
```bash
7891
# Clone the repository
@@ -89,6 +102,12 @@ uv run pytest
89102
uv run tim-mcp
90103
```
91104

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+
92111
## Transport Modes
93112

94113
TIM-MCP supports two transport modes for different deployment scenarios:

0 commit comments

Comments
 (0)