Skip to content

Commit e4ff98a

Browse files
[MINOR] docs(mcp): polish MCP server document (#8605)
### What changes were proposed in this pull request? 1. Polish how to start mcp server by docker 2. change `--uri` to `--gravitino-uri` ### Why are the changes needed? make it more user friendly. ### Does this PR introduce _any_ user-facing change? no ### How was this patch tested? just document Co-authored-by: FANNG <xiaojing@datastrato.com>
1 parent bf81c39 commit e4ff98a

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

docs/gravitino-mcp-server.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ Gravitino MCP server provides the ability to manage Gravitino metadata for LLM.
3131
"mcp_server",
3232
"--metalake",
3333
"test",
34-
"--uri",
34+
"--gravitino-uri",
3535
"http://127.0.0.1:8090"
3636
]
3737
}
3838
}
3939
}
4040
```
4141

42-
Or start an HTTP MCP server by `uv run mcp_server --metalake test --uri http://127.0.0.1:8090 --transport http --mcp-url http://localhost:8000/mcp`, and use the configuration:
42+
Or start an HTTP MCP server by `uv run mcp_server --metalake test --gravitino-uri http://127.0.0.1:8090 --transport http --mcp-url http://localhost:8000/mcp`, and use the configuration:
4343

4444
```json
4545
{
@@ -53,7 +53,7 @@ Or start an HTTP MCP server by `uv run mcp_server --metalake test --uri http://1
5353

5454
### Docker instructions
5555

56-
You could start Gravitino MCP server by docker image, `docker run -p 8000:8000 apache/gravitino-mcp-server:latest --metalake test --transport http --mcp-url http://0.0.0.0:8000/mcp`. Please note that the MCP server in docker container doesn't support `stdio` transport mode.
56+
You could start Gravitino MCP server by Docker image, `docker run -p 8000:8000 --network=host apache/gravitino-mcp-server:latest --metalake test --transport http --mcp-url http://0.0.0.0:8000/mcp --gravitino-uri http://127.0.0.1:8090`. Please note that the MCP server in Docker container doesn't support `stdio` transport mode.
5757

5858
### Supported tools
5959

@@ -101,9 +101,9 @@ Gravitino MCP server supports the following tools, and you could export tool by
101101

102102
You could config Gravitino MCP server by arguments, `uv run mcp_server -h` shows the detailed information.
103103

104-
| Argument | Description | Default value | Required | Since version |
105-
|---------------|-----------------------------------------------------------------|-----------------------------|----------|---------------|
106-
| `--metalake` | The Gravitino metalake name. | none | Yes | 1.0.0 |
107-
| `--uri` | The URI of Gravitino server. | `http://127.0.0.1:8090` | No | 1.0.0 |
108-
| `--transport` | Transport protocol type: stdio (local), http (Streamable HTTP). | `stdio` | No | 1.0.0 |
109-
| `--mcp-url` | The url of MCP server if using http transport. | `http://127.0.0.1:8000/mcp` | No | 1.0.0 |
104+
| Argument | Description | Default value | Required | Since version |
105+
|-------------------|-----------------------------------------------------------------|-----------------------------|----------|---------------|
106+
| `--metalake` | The Gravitino metalake name. | none | Yes | 1.0.0 |
107+
| `--gravitino-uri` | The URI of Gravitino server. | `http://127.0.0.1:8090` | No | 1.0.0 |
108+
| `--transport` | Transport protocol type: stdio (local), http (Streamable HTTP). | `stdio` | No | 1.0.0 |
109+
| `--mcp-url` | The url of MCP server if using http transport. | `http://127.0.0.1:8000/mcp` | No | 1.0.0 |

mcp-server/mcp_server/core/context.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
class GravitinoContext:
2323
def __init__(self, setting: Setting):
2424
self.gravitino_client = RESTClientFactory.create_rest_client(
25-
setting.metalake, setting.uri
25+
setting.metalake, setting.gravitino_uri
2626
)
2727

2828
def rest_client(self):

mcp-server/mcp_server/core/setting.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@
2121

2222
@dataclass
2323
class DefaultSetting:
24-
default_uri: str = "http://127.0.0.1:8090"
24+
default_gravitino_uri: str = "http://127.0.0.1:8090"
2525
default_transport: str = "stdio"
2626
default_mcp_url: str = "http://127.0.0.1:8000/mcp"
2727

2828

2929
@dataclass
3030
class Setting:
3131
metalake: str
32-
uri: str = DefaultSetting.default_uri
32+
gravitino_uri: str = DefaultSetting.default_gravitino_uri
3333
tags: Set[str] = field(default_factory=set)
3434
transport: str = DefaultSetting.default_transport
3535
mcp_url: str = DefaultSetting.default_mcp_url

mcp-server/mcp_server/main.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def do_main():
2626
args = _parse_args()
2727
setting = Setting(
2828
metalake=args.metalake,
29-
uri=args.uri,
29+
gravitino_uri=args.gravitino_uri,
3030
tags=args.include_tool_tags,
3131
transport=args.transport,
3232
mcp_url=args.mcp_url,
@@ -55,7 +55,7 @@ def _comma_separated_set(value) -> set:
5555
def _parse_args():
5656
parser = argparse.ArgumentParser(
5757
description="Gravitino Mcp server",
58-
epilog="Example: uv run mcp_server --metalake test --uri http://127.0.0.1:8090",
58+
epilog="Example: uv run mcp_server --metalake test --gravitino-uri http://127.0.0.1:8090",
5959
)
6060

6161
parser.add_argument(
@@ -65,10 +65,10 @@ def _parse_args():
6565
help="Gravitino metalake name.",
6666
)
6767
parser.add_argument(
68-
"--uri",
68+
"--gravitino-uri",
6969
type=str,
70-
default=DefaultSetting.default_uri,
71-
help=f"The uri of Gravitino server. (default: {DefaultSetting.default_uri})",
70+
default=DefaultSetting.default_gravitino_uri,
71+
help=f"The uri of Gravitino server. (default: {DefaultSetting.default_gravitino_uri})",
7272
)
7373

7474
parser.add_argument(

0 commit comments

Comments
 (0)