This is an automated email from the ASF dual-hosted git repository.
jshao pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new c2fd69d11d [MINOR] docs(mcp): polish MCP server document (#8600)
c2fd69d11d is described below
commit c2fd69d11dbb1a706b70e1763fc3e719aac1014c
Author: FANNG <[email protected]>
AuthorDate: Thu Sep 18 16:17:13 2025 +0900
[MINOR] docs(mcp): polish MCP server document (#8600)
### 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
---
docs/gravitino-mcp-server.md | 18 +++++++++---------
mcp-server/mcp_server/core/context.py | 2 +-
mcp-server/mcp_server/core/setting.py | 4 ++--
mcp-server/mcp_server/main.py | 10 +++++-----
4 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/docs/gravitino-mcp-server.md b/docs/gravitino-mcp-server.md
index 9c080e056b..604f1f179f 100644
--- a/docs/gravitino-mcp-server.md
+++ b/docs/gravitino-mcp-server.md
@@ -31,7 +31,7 @@ Gravitino MCP server provides the ability to manage Gravitino
metadata for LLM.
"mcp_server",
"--metalake",
"test",
- "--uri",
+ "--gravitino-uri",
"http://127.0.0.1:8090";
]
}
@@ -39,7 +39,7 @@ Gravitino MCP server provides the ability to manage Gravitino
metadata for LLM.
}
```
-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:
+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:
```json
{
@@ -53,7 +53,7 @@ Or start an HTTP MCP server by `uv run mcp_server --metalake
test --uri http://1
### Docker instructions
-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.
+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.
### Supported tools
@@ -101,9 +101,9 @@ Gravitino MCP server supports the following tools, and you
could export tool by
You could config Gravitino MCP server by arguments, `uv run mcp_server -h`
shows the detailed information.
-| Argument | Description
| Default value | Required | Since version |
-|---------------|-----------------------------------------------------------------|-----------------------------|----------|---------------|
-| `--metalake` | The Gravitino metalake name.
| none | Yes | 1.0.0 |
-| `--uri` | The URI of Gravitino server.
| `http://127.0.0.1:8090` | No | 1.0.0 |
-| `--transport` | Transport protocol type: stdio (local), http (Streamable
HTTP). | `stdio` | No | 1.0.0 |
-| `--mcp-url` | The url of MCP server if using http transport.
| `http://127.0.0.1:8000/mcp` | No | 1.0.0 |
+| Argument | Description
| Default value | Required | Since version |
+|-------------------|-----------------------------------------------------------------|-----------------------------|----------|---------------|
+| `--metalake` | The Gravitino metalake name.
| none | Yes | 1.0.0 |
+| `--gravitino-uri` | The URI of Gravitino server.
| `http://127.0.0.1:8090` | No | 1.0.0 |
+| `--transport` | Transport protocol type: stdio (local), http (Streamable
HTTP). | `stdio` | No | 1.0.0 |
+| `--mcp-url` | The url of MCP server if using http transport.
| `http://127.0.0.1:8000/mcp` | No | 1.0.0 |
diff --git a/mcp-server/mcp_server/core/context.py
b/mcp-server/mcp_server/core/context.py
index 06dde17da3..6e540a0b51 100644
--- a/mcp-server/mcp_server/core/context.py
+++ b/mcp-server/mcp_server/core/context.py
@@ -22,7 +22,7 @@ from mcp_server.core.setting import Setting
class GravitinoContext:
def __init__(self, setting: Setting):
self.gravitino_client = RESTClientFactory.create_rest_client(
- setting.metalake, setting.uri
+ setting.metalake, setting.gravitino_uri
)
def rest_client(self):
diff --git a/mcp-server/mcp_server/core/setting.py
b/mcp-server/mcp_server/core/setting.py
index 996a96ba6d..474fdbc6b4 100644
--- a/mcp-server/mcp_server/core/setting.py
+++ b/mcp-server/mcp_server/core/setting.py
@@ -21,7 +21,7 @@ from typing import Set
@dataclass
class DefaultSetting:
- default_uri: str = "http://127.0.0.1:8090";
+ default_gravitino_uri: str = "http://127.0.0.1:8090";
default_transport: str = "stdio"
default_mcp_url: str = "http://127.0.0.1:8000/mcp";
@@ -29,7 +29,7 @@ class DefaultSetting:
@dataclass
class Setting:
metalake: str
- uri: str = DefaultSetting.default_uri
+ gravitino_uri: str = DefaultSetting.default_gravitino_uri
tags: Set[str] = field(default_factory=set)
transport: str = DefaultSetting.default_transport
mcp_url: str = DefaultSetting.default_mcp_url
diff --git a/mcp-server/mcp_server/main.py b/mcp-server/mcp_server/main.py
index e48ee69686..73a5aa265f 100644
--- a/mcp-server/mcp_server/main.py
+++ b/mcp-server/mcp_server/main.py
@@ -26,7 +26,7 @@ def do_main():
args = _parse_args()
setting = Setting(
metalake=args.metalake,
- uri=args.uri,
+ gravitino_uri=args.gravitino_uri,
tags=args.include_tool_tags,
transport=args.transport,
mcp_url=args.mcp_url,
@@ -55,7 +55,7 @@ def _comma_separated_set(value) -> set:
def _parse_args():
parser = argparse.ArgumentParser(
description="Gravitino Mcp server",
- epilog="Example: uv run mcp_server --metalake test --uri
http://127.0.0.1:8090";,
+ epilog="Example: uv run mcp_server --metalake test --gravitino-uri
http://127.0.0.1:8090";,
)
parser.add_argument(
@@ -65,10 +65,10 @@ def _parse_args():
help="Gravitino metalake name.",
)
parser.add_argument(
- "--uri",
+ "--gravitino-uri",
type=str,
- default=DefaultSetting.default_uri,
- help=f"The uri of Gravitino server. (default:
{DefaultSetting.default_uri})",
+ default=DefaultSetting.default_gravitino_uri,
+ help=f"The uri of Gravitino server. (default:
{DefaultSetting.default_gravitino_uri})",
)
parser.add_argument(
