Skip to content

Commit 86b6ba9

Browse files
authored
Update README.md (#210)
* Update README.md * Set Go version
1 parent 2c0c178 commit 86b6ba9

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ We're developing a Kubernetes operator, guided by our internal roadmap, to exten
2222

2323
## The Problem
2424

25-
ML teams build agents that work perfectly locally. Operations teams get handed Python scripts and told "make this production-ready across dev/UAT/prod."
25+
ML teams build agents that work perfectly locally. Operations teams often get handed Python scripts with little context and told "make this production-ready across dev/UAT/prod."
2626
The gap between local development and enterprise deployment kills AI initiatives.
2727

2828
`mcpd` solves this with declarative configuration, secure secrets management, and seamless environment promotion - all while keeping the developer experience simple.
@@ -31,19 +31,19 @@ The gap between local development and enterprise deployment kills AI initiatives
3131
## Why `mcpd`?
3232

3333
**Zero-Config Tool Setup**
34-
No cloning repos or installing language-specific dependencies. `mcpd add` and `mcpd daemon` handle everything.
34+
No need to clone multiple repos or install language-specific dependencies. `mcpd add` and `mcpd daemon` handle everything.
3535

3636
**Language-Agnostic Tooling**
37-
Use MCP servers in Docker containers or written in Python, JavaScript, TypeScript via a unified HTTP API.
37+
Use MCP servers in Docker containers or written in Python, JavaScript, or TypeScript via a unified HTTP API.
3838

3939
**Declarative Configuration**
4040
Version-controlled `.mcpd.toml` files define your agent infrastructure. Reproducible, auditable, CI-friendly.
4141

4242
**Enterprise-Ready Secrets**
43-
Separate project configuration from runtime variables, and export sanitized secrets templates. Never commit secrets to Git again.
43+
Separate project configuration from runtime variables, and export sanitized secrets templates. No need to commit secrets to Git ever again.
4444

4545
**Seamless Local-to-Prod**
46-
Same configuration works in development, CI, and cloud environments without modification.
46+
Same configuration works in development, CI, and cloud environments without modification or risky hand-offs.
4747

4848

4949
## Built for Dev & Production
@@ -68,10 +68,13 @@ Same configuration works in development, CI, and cloud environments without modi
6868

6969
### Prerequisites
7070

71-
- [Docker](https://www.docker.com/products/docker-desktop/)
72-
- [Go](https://go.dev/doc/install) (only required for development of `mcpd`)
73-
- [npx](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
74-
- [uvx](https://docs.astral.sh/uv/getting-started/installation/)
71+
You need the following installed before running `mcpd`:
72+
- [**Docker**](https://www.docker.com/products/docker-desktop/)
73+
- [**npx**](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) (Node.js package runner)
74+
- [**uvx**](https://docs.astral.sh/uv/getting-started/installation/) (Universal virtual environment manager)
75+
76+
If you are developing `mcpd`, you will also need:
77+
- [**Go**](https://go.dev/doc/install) (v1.25.1+ recommended)
7578

7679
### Installation
7780

@@ -173,7 +176,7 @@ API docs will be available at [http://localhost:8090/docs](http://localhost:8090
173176
| Language | Repository | Status |
174177
|------------|--------------------------------------------------------------------------|--------|
175178
| Python | [mcpd-sdk-python](https://github.com/mozilla-ai/mcpd-sdk-python) ||
176-
| JavaScript | [mcpd-sdk-javascript](https://github.com/mozilla-ai/mcpd-sdk-javascript) | 🟡 |
179+
| JavaScript | [mcpd-sdk-javascript](https://github.com/mozilla-ai/mcpd-sdk-javascript) | |
177180

178181

179182
### `mcpd` plugin SDKs

docs/requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ To use `mcpd`, ensure the following tools are installed:
55
| Tool | Purpose | URL |
66
|----------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
77
| `Docker` | For running MCP servers as Docker containers | [https://www.docker.com/products/docker-desktop/](https://www.docker.com/products/docker-desktop/) |
8-
| `Go >= 1.25.0` | Required for building `mcpd` and running tests | [https://go.dev/doc/install](https://go.dev/doc/install) |
8+
| `Go >= 1.25.1` | Required for building `mcpd` and running tests | [https://go.dev/doc/install](https://go.dev/doc/install) |
99
| `uv` | For running `uvx` Python packages in `mcpd`, and local docs | [https://docs.astral.sh/uv/getting-started/installation/](https://docs.astral.sh/uv/getting-started/installation/) |
1010
| `npx` | For running JavaScript/TypeScript packages in `mcpd` | [https://docs.npmjs.com/downloading-and-installing-node-js-and-npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) |
1111

0 commit comments

Comments
 (0)