Skip to content

Commit 4e7b209

Browse files
committed
update Readme.md
1 parent c6f9389 commit 4e7b209

File tree

3 files changed

+50
-5
lines changed

3 files changed

+50
-5
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ build:
1212

1313
.PHONY: install
1414
install:
15-
pip install dist/h2ogpte_mcp_server-*.whl
15+
python -m pip install dist/h2ogpte_mcp_server-*.whl
1616

1717
.PHONY: uninstall
1818
uninstall:
19-
pip uninstall h2ogpte_mcp_server
19+
python -m pip uninstall h2ogpte_mcp_server
2020

2121
.PHONY: upload
2222
upload:

README.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,48 @@
1-
# MCP API server
1+
# H2OGPTe MCP Server
2+
3+
H2OGPTe MCP Server is a Model Context Protocol (MCP) server that prifor the [H2OGPTe](https://h2o.ai/platform/enterprise-h2ogpte/) project.
4+
The server is just a local proxy forwarding traffic to [REST API endpoints of H2OGPTe](https://h2ogpte.genai.h2o.ai/swagger-ui/) executed as commnad.
5+
6+
## Installation
7+
8+
### From Pypi
9+
10+
```sh
11+
pip install h2ogpte-mcp-server
12+
```
13+
14+
### From Github
15+
16+
```sh
17+
# Clone git repository
18+
git clone https://github.com/h2oai/h2ogpte-mcp-server.git
19+
20+
make setup
21+
make build
22+
23+
# The command will install h2ogpte-mcp-server to the current python environment
24+
make install
25+
```
26+
27+
## Usage
28+
29+
### Environment Variables
30+
- **API_KEY** - (required) H2OGPTe access key. See [documentation](https://docs.h2o.ai/enterprise-h2ogpte/guide/apis#create-an-api-key) on how to get the key.
31+
- **H2OGPTE_SERVER_URL** - The url of H2OGPTe server. Default value is [https://h2ogpte.genai.h2o.ai](https://h2ogpte.genai.h2o.ai).
32+
33+
### Example Configuration
34+
35+
```json
36+
{
37+
"mcpServers": {
38+
"h2ogpte-mcp-server": {
39+
"command": "h2ogpte-mcp-server",
40+
"env": {
41+
"API_KEY": "sk-...",
42+
"H2OGPTE_SERVER_URL": "https://h2ogpte.genai.h2o.ai"
43+
}
44+
}
45+
}
46+
}
47+
```
248

3-
MCP API Proxy forwarding the calls to H2OGPTe REST API.

src/h2ogpte_mcp_server/settings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44

55
class Settings(BaseSettings):
6-
h2ogpte_server_url: str = Field("http://localhost:8888")
6+
h2ogpte_server_url: str = Field("https://h2ogpte.genai.h2o.ai")
77
api_key: str = Field()
88

99

0 commit comments

Comments
 (0)