Skip to content

Commit e215ac3

Browse files
committed
docs: Prioritize Docker-based quick start in README, update client configuration examples, and add sections for local development and advanced Docker setup.
1 parent ddcc906 commit e215ac3

1 file changed

Lines changed: 106 additions & 78 deletions

File tree

README.md

Lines changed: 106 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<p><strong>Model Context Protocol Server for Valorant Data</strong></p>
44

55
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
6+
[![Docker](https://img.shields.io/badge/Docker-Ready-2496ED?logo=docker&logoColor=white)](https://www.docker.com/)
67
[![Python](https://img.shields.io/badge/Python-3.13+-ffd43b?logo=python&logoColor=blue)](https://www.python.org/)
78
[![MCP](https://img.shields.io/badge/MCP-Ready-00E5FF)](https://modelcontextprotocol.io/)
89
[![API](https://img.shields.io/badge/API-HenrikDev-red)](https://docs.henrikdev.xyz/)
@@ -19,8 +20,8 @@
1920
- [Features](#-features)
2021
- [Demo / Screenshots](#-demo--screenshots)
2122
- [Tech Stack](#-tech-stack)
22-
- [Getting Started](#-getting-started)
23-
- [Usage / Setup](#-usage--setup)
23+
- [Quick Start / Setup](#-quick-start--setup)
24+
- [Local Development & Advanced Setup](#-local-development--advanced-setup)
2425
- [Credits](#-credits)
2526
- [License](#-license)
2627

@@ -53,139 +54,166 @@ Built with modern Python tooling for maximum performance and reliability:
5354
- ![Python](https://img.shields.io/badge/Python-3.13-blue?logo=python&logoColor=white) **Python 3.13+**
5455
- ![uv](https://img.shields.io/badge/uv-Package%20Manager-purple) **uv** for blazing-fast dependency management
5556
- ![httpx](https://img.shields.io/badge/httpx-Async%20HTTP-green) **httpx** for non-blocking API calls
56-
- ![MCP](https://img.shields.io/badge/MCP-Protocol-00E5FF) **mcp[cli]** for seamless Model Context Protocol integration
57+
- ![MCP](https://img.shields.io/badge/MCP-Protocol-00E5FF) **mcp[cli]** for seamless Model Context Pr## 🚀 Quick Start / Setup
5758

58-
---
59-
60-
## 🚀 Getting Started
61-
62-
Follow these steps to get the server running locally on your machine.
63-
64-
### Prerequisites
59+
To use this server, you need a **Henrik API Key** (get one at [HenrikDev Docs](https://docs.henrikdev.xyz/)) and **Docker** installed.
6560

66-
- **Python 3.13** or higher installed.
67-
- **uv** package manager installed (`pip install uv` or via standalone installer).
68-
- A valid **Henrik API Key**. Get one at [HenrikDev Docs](https://docs.henrikdev.xyz/).
69-
70-
### Installation
71-
72-
1. **Clone the repository:**
73-
74-
```bash
75-
git clone https://github.com/codeNilson/valorant-mcp-server
76-
cd valorant-mcp-server
77-
```
78-
79-
2. **Sync dependencies using `uv`:**
80-
81-
```bash
82-
uv sync
83-
```
84-
85-
3. **Configure Environment Variables:**
86-
Create a `.env` file in the root directory and add your API key:
87-
88-
```env
89-
HENRIK_API_KEY=your_api_key_here
90-
```
91-
92-
---
93-
94-
## 🔌 Usage / Setup
95-
96-
To use this server, you need to configure your MCP client. Find your preferred client below and copy the configuration snippet.
97-
98-
> ⚠️ **Note:** Make sure to replace `C:\\path\\to\\valorant-mcp-server` with the actual absolute path to the directory where you cloned this repository.
61+
Configure your preferred MCP client by adding the following snippet to your configuration file. *You do not need to clone the repository to use the server; the official Docker image will be used automatically.*
9962

10063
### 🤖 Claude Desktop
10164

10265
**Where to find the config file:**
103-
104-
- **Windows:** `%APPDATA%\\Claude\\claude_desktop_config.json`
66+
- **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
10567
- **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
10668
- **Linux:** `~/.config/Claude/claude_desktop_config.json`
10769

10870
**Configuration:**
109-
11071
```json
11172
{
11273
"mcpServers": {
11374
"valorant-mcp-server": {
114-
"command": "uv",
75+
"command": "docker",
11576
"args": [
11677
"run",
117-
"valorant-mcp-server"
118-
],
119-
"cwd": "C:\\path\\to\\valorant-mcp-server",
120-
"env": {
121-
"HENRIK_API_KEY": "your_api_key_here"
122-
}
78+
"-i",
79+
"--rm",
80+
"-e",
81+
"HENRIK_API_KEY=your_api_key_here",
82+
"ghcr.io/codenilson/valorant-mcp-server:latest"
83+
]
12384
}
12485
}
12586
}
12687
```
127-
12888
*Restart Claude Desktop entirely after saving the file.*
12989

13090
### 🌌 Antigravity
13191

13292
**Where to find the config file:**
133-
13493
- Built into the Antigravity UI directly, usually in Settings -> MCP Servers.
13594

13695
**Configuration:**
13796
Simply add this to your MCP servers configuration menu or JSON:
138-
13997
```json
14098
{
14199
"mcpServers": {
142-
"valorant": {
143-
"command": "uv",
100+
"valorant-mcp-server": {
101+
"command": "docker",
144102
"args": [
145103
"run",
146-
"valorant-mcp-server"
147-
],
148-
"cwd": "C:\\path\\to\\valorant-mcp-server",
149-
"env": {
150-
"HENRIK_API_KEY": "your_api_key_here"
151-
}
104+
"-i",
105+
"--rm",
106+
"-e",
107+
"HENRIK_API_KEY=your_api_key_here",
108+
"ghcr.io/codenilson/valorant-mcp-server:latest"
109+
]
152110
}
153111
}
154112
}
155113
```
156114

157-
*No restart usually required, but refresh if necessary.*
158-
159115
### 💻 VS Code (Roo Code / Cline)
160116

161117
**Where to find the config file:**
162-
163-
- Typically located in `~/.vscode/mcp.json` or within the extension's specific MCP settings UI. (e.g., `%APPDATA%\\Code\\User\\globalStorage\\rooveterinaryinc.roo-cline\\settings\\cline_mcp_settings.json` on Windows).
118+
- Typically located in `~/.vscode/mcp.json` or within the extension's specific MCP settings UI. (e.g., `%APPDATA%\Code\User\globalStorage\rooveterinaryinc.roo-cline\settings\cline_mcp_settings.json` on Windows).
164119

165120
**Configuration:**
166-
167121
```json
168122
{
169123
"mcpServers": {
170-
"valorant": {
171-
"command": "uv",
124+
"valorant-mcp-server": {
125+
"command": "docker",
172126
"args": [
173127
"run",
174-
"valorant-mcp-server"
175-
],
176-
"cwd": "C:\\path\\to\\valorant-mcp-server",
177-
"env": {
178-
"HENRIK_API_KEY": "your_api_key_here"
179-
}
128+
"-i",
129+
"--rm",
130+
"-e",
131+
"HENRIK_API_KEY=your_api_key_here",
132+
"ghcr.io/codenilson/valorant-mcp-server:latest"
133+
]
180134
}
181135
}
182136
}
183137
```
184-
185138
*Reload the VS Code window (`Ctrl+Shift+P` -> `Developer: Reload Window`) after saving.*
186139

187140
---
188141

142+
## 🛠 Local Development & Advanced Setup
143+
144+
If you want to run the server from source, build the Docker image locally, or contribute to the project, follow these steps.
145+
146+
### Prerequisites
147+
- **Python 3.13+** and **uv** package manager
148+
- **Git**
149+
150+
### Option 1: Local Development (via uv)
151+
152+
1. **Clone the repository:**
153+
```bash
154+
git clone https://github.com/codeNilson/valorant-mcp-server
155+
cd valorant-mcp-server
156+
```
157+
158+
2. **Sync dependencies:**
159+
```bash
160+
uv sync
161+
```
162+
163+
3. **Client Configuration:**
164+
Configure your MCP client to run the local version directly using `uv`:
165+
```json
166+
{
167+
"mcpServers": {
168+
"valorant-mcp-server": {
169+
"command": "uv",
170+
"args": [
171+
"--directory",
172+
"C:\\path\\to\\valorant-mcp-server",
173+
"run",
174+
"valorant-mcp-server"
175+
],
176+
"env": {
177+
"HENRIK_API_KEY": "your_api_key_here"
178+
}
179+
}
180+
}
181+
}
182+
```
183+
184+
### Option 2: Build Docker Image Locally
185+
186+
If you prefer to build the container yourself instead of using the pre-built image:
187+
188+
1. **Clone and build:**
189+
```bash
190+
git clone https://github.com/codeNilson/valorant-mcp-server
191+
cd valorant-mcp-server
192+
docker build -t valorant-mcp-server .
193+
```
194+
195+
2. **Client Configuration:**
196+
Use the same configuration as the Quick Start, but replace the `ghcr.io/...` image with your local tag:
197+
```json
198+
{
199+
"mcpServers": {
200+
"valorant-mcp-server": {
201+
"command": "docker",
202+
"args": [
203+
"run",
204+
"-i",
205+
"--rm",
206+
"-e",
207+
"HENRIK_API_KEY=your_api_key_here",
208+
"valorant-mcp-server"
209+
]
210+
}
211+
}
212+
}
213+
```
214+
215+
---
216+
189217
## 🙏 Credits
190218

191219
This project is made possible thanks to the **Henrik API** providing the unofficial Valorant API data endpoints.

0 commit comments

Comments
 (0)