Merge pull request #3 from yfsmooth/feat_mongodb_readme

modify mongodb readme

Author: zihengli-bytedance

server/mcp_server_mongodb/README.md

@@ -5,31 +5,120 @@
 v1
 
 ## 产品描述
+### 短描述
+mongo管控面sdk mcp server
+
+### 长描述
 火山 mongo 管控面 sdk 的 mcp server，使客户可以自然语言的方式调用SDK
 
 ## 分类
-
-#文档型数据库MongoDB
+数据库
 
 ## 标签
 #存储#数据库#文档型#MongoDB
 ## Tools
-
-### list_db_instances
+本 MCP Server 产品提供以下 Tools (工具/能力):
+### describe_db_instances
 #### 详细描述:
 获取MongoDB实例列表和数量
-### db_instance_detail
+#### 调试缩需要输入参数:
+输入：
+```json
+{
+  inputSchema={
+    "type": "object",
+    "properties": {
+        "instance_id": {"type": "string", "description": "MongoDB 实例ID"},
+        "instance_name": {"type": "string", "description": "MongoDB 实例名称"},
+        "page_size": {"type": "integer", "description": "实例列表每页大小"},
+    },
+    "required": ["page_number", "page_size"],
+  }
+}
+```
+### describe_db_instance_detail
 #### 详细描述:
 返回MongoDB实例的详情信息
-### list_db_instance_backups
+#### 调试缩需要输入参数:
+输入：
+```json
+{
+  inputSchema={
+    "type": "object",
+    "properties": {
+        "instance_id": {"type": "string", "description": "MongoDB实例ID"}
+    },
+    "required": ["instance_id"]
+  }
+}
+```
+### describe_backups_request
 #### 详细描述:
 获取MongoDB实例备份信息列表
-### list_db_instance_params
+#### 调试缩需要输入参数:
+输入：
+```json
+{
+  inputSchema={
+    "type": "object",
+    "properties": {
+        "instance_id": {"type": "string", "description": "MongoDB实例ID"},
+        "backup_object": {
+            "type": "string", "enum": ["Data", "Log"], "description": "备份对象，全量数据备份或者是日志备份"
+        },
+        "backup_status": {
+            "type": "string", "enum": ["Success", "Failed", "Running"],
+            "description": "备份状态"
+        },
+        "backup_type": {
+            "type": "string", "enum": ["Logical", "Physical"], "description": "备份方式, 物理备份或者是逻辑备份"
+        },
+        "page_number": {"type": "integer", "description": "备份列表页数"}
+    }
+}
+```
+### describe_db_instance_parameters
 #### 详细描述:
 获取MongoDB实例参数列表
+#### 调试缩需要输入参数:
+输入：
+```json
+{
+  inputSchema={
+      "type": "object",
+      "properties": {
+          "instance_id": {"type": "string", "description": "MongoDB实例ID"},
+          "parameter_role": {
+              "type": "string",
+              "enum": ["Node", "Shard", "ConfigServer", "Mongos"],
+              "description": "MongoDB实例组件角色, 副本集对应Node, 分片集群的各个组件对应Shard, ConfigServer, Mongos",
+          },
+      },
+      "required": ["instance_id"],
+  }
+}
+```
 ### describe_slow_log
 #### 详细描述:
 获取MongoDB慢日志列表
+#### 调试缩需要输入参数:
+输入：
+```json
+{
+  inputSchema={
+      "type": "object",
+      "properties": {
+          "instance_id": {"type": "string", "description": "MongoDB实例ID"},
+          "context": {"type": "context", "description": "上一页慢日志最后一条的位置标识"},
+          "pod_name": {"type": "string", "description": "MongoDB实例pod name，也是实例的 node_id, "
+                "db_instance_detail 方法中可以获取到, 格式: instance_id-${index}"},
+          "start_time": {"type": "integer", "description": "查询慢日志的开始时间戳"},
+          "end_time": {"type": "integer", "description": "查询慢日志的结束时间戳"},
+      },
+      "required": ["instance_id", "limit", "start_time", "end_time", "sort", "pod_name"],
+  }
+}
+```
 
 
 ## 可适配平台  
@@ -98,12 +187,12 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
 ```json
 {
     "mcpServers": {
-        "las-dataset-mcp": {
+        "mcp-server-mongodb": {
             "command": "uvx",
             "args": [
             "--from",
             "git+https://github.com/volcengine/mcp-server#subdirectory=server/mcp_server_mongodb",
-            "mcp-server-mognodb"
+            "mcp-server-mongodb"
           ],
             "env": {
                 "VOLC_ACCESSKEY": "your-access-key-id",
@@ -116,6 +205,6 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
 ```
 
 ## License
-MIT
+volcengine/mcp-server is licensed under the [MIT License](https://github.com/volcengine/mcp-server/blob/main/LICENSE).
 
 

server/mcp_server_mongodb/pyproject.toml

@@ -1,10 +1,17 @@
 [project]
-name = "mongodb-mgr-sdk-mcp-server"
+name = "mcp_server_mongodb"
 version = "0.1.0"
-description = "Add your description here"
+description = "MCP Server for Mongo"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
     "mcp[cli]",
     "volcengine-python-sdk",
 ]
+
+[project.scripts]
+mcp-server-mongodb = "mcp_server_mongodb.server:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

server/mcp_server_mongodb/src/mcp_server_mongodb/server.py

@@ -4,7 +4,7 @@
 import argparse
 from typing import Any, Literal
 from mcp.server.fastmcp import FastMCP
-from resource.mongo_resource import MongoDBSDK
+from mcp_server_mongodb.resource.mongo_resource import MongoDBSDK
 
 # 初始化MCP服务
 mcp_server = FastMCP("mongodb_mcp_server", port=int(os.getenv("PORT", "8000")))