Skip to content

Commit 67f16b4

Browse files
committed
docs: add readme
1 parent bf48147 commit 67f16b4

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Terraform IBM Modules (TIM) MCP Server
2+
3+
A MCP server designed to help leverage Terraform IBM Modules (TIM) to create comprehensive infrastructure solutions on IBM Cloud.
4+
5+
## Overview
6+
7+
TIM-MCP is a specialized FastMCP server that enables searching, retrieving, and utilizing Terraform IBM Modules to generate complete infrastructure configurations for IBM Cloud.
8+
9+
For detailed information about the server's functionality and usage, please refer to the [LLM Instructions](static/llm_instructions.md).
10+
11+
## Installation
12+
13+
### Prerequisites
14+
15+
- Python 3.12
16+
- PDM (Python Dependency Manager)
17+
18+
### Setup
19+
20+
1. Clone the repository:
21+
```bash
22+
git clone <repository-url>
23+
cd tim-mcp
24+
```
25+
26+
2. Install dependencies using PDM:
27+
```bash
28+
pdm install
29+
```
30+
31+
## Usage
32+
33+
### Running in Debug Mode
34+
35+
```bash
36+
fastmcp dev server.py
37+
```
38+
39+
### Editor Configuration
40+
41+
Add the following configuration to your editor settings to support MCP:
42+
43+
```json
44+
{
45+
"terraform-ibm-modules mcp server": {
46+
"command": "uv",
47+
"args": [
48+
"run",
49+
"--with",
50+
"fastmcp",
51+
"fastmcp",
52+
"run",
53+
"/path/to/tim-mcp/server.py"
54+
]
55+
}
56+
}
57+
```
58+
59+
Replace `/path/to/tim-mcp` with the actual path to your project directory.

0 commit comments

Comments
 (0)