yuanzhipeng
635313a7ab
feat(lzwcai-agile-db): 更新版本至0.4.4并优化数据库管理技能文档 - 更新版本号从0.4.2到0.4.4 - 优化API密钥权限管理说明，明确grant_api_key_permissions仅支持追加不支持撤销 - 新增add_sql_tool_to_datasource工具，提供一键创建SQL工具功能 - 调整create_sql_tool说明，强调需技能已存在 - 强化数据写操作安全机制，插入/更新/删除前必须预览并等待用户确认 - 完善导入数据功能说明，详细解释confirm_import_data参数传递方式 - 补充技能与工具管理流程，提供更清晰的操作指引 - 新增数字员工平台数据库技能配置指南文档 ```
87 lines
2.7 KiB
Markdown
87 lines
2.7 KiB
Markdown
# lzwcai-mcp-agile-db
|
||
|
||
数据库管理平台 MCP Server，提供 34 个工具用于数据库管理、表操作、数据 CRUD、API 密钥管理、技能与工具管理等。
|
||
|
||
## 环境变量
|
||
|
||
| 变量名 | 必填 | 说明 |
|
||
|--------|------|------|
|
||
| `API_KEY` | 是 | 数据库管理平台的 API 密钥（格式: `Bearer <token>`） |
|
||
| `backendBaseUrl` | 否 | 数据库管理平台后端地址（默认 `http://lzwcai-demp-corp-manager:8086`） |
|
||
|
||
## 安装
|
||
|
||
```bash
|
||
pip install -e .
|
||
```
|
||
|
||
## 运行
|
||
|
||
```bash
|
||
# 设置环境变量
|
||
export API_KEY="Bearer your-token"
|
||
export backendBaseUrl="https://dempdemo.lzwcai.com" # 可选
|
||
|
||
# 运行 MCP Server
|
||
lzwcai-mcp-agile-db
|
||
```
|
||
|
||
## 工具列表
|
||
|
||
### 数据源管理
|
||
- `list_datasources` - 获取数据源列表
|
||
- `get_datasource_detail` - 获取数据源详情
|
||
- `create_datasource` - 创建数据源
|
||
- `update_datasource` - 更新数据源
|
||
- `toggle_datasource_status` - 启用/停用数据源
|
||
- `delete_datasource` - 删除数据源
|
||
|
||
### 数据库与表管理
|
||
- `list_databases` - 获取数据库列表
|
||
- `list_tables` - 获取表列表
|
||
- `get_table_detail` - 获取表详情
|
||
- `create_table` - 创建表
|
||
- `alter_table` - 修改表结构
|
||
- `generate_table_by_description` - 通过自然语言生成表结构
|
||
|
||
### 表数据 CRUD
|
||
- `query_table_data` - 查询表数据
|
||
- `insert_table_row` - 插入行数据
|
||
- `update_table_row` - 更新行数据
|
||
- `delete_table_rows` - 删除行数据
|
||
- `export_table_excel` - 导出 Excel
|
||
|
||
### API 密钥管理
|
||
- `list_api_keys` - 获取密钥列表
|
||
- `create_api_key` - 创建密钥
|
||
- `toggle_api_key_status` - 启用/禁用密钥
|
||
- `delete_api_key` - 删除密钥
|
||
- `get_api_key_permissions` - 查看密钥权限
|
||
- `grant_api_key_permissions` - 授予权限（仅追加，不可撤销）
|
||
|
||
### 技能与工具管理
|
||
- `add_sql_tool_to_datasource` - 把 SQL 沉淀为工具（一步到位，自动建技能+配模板+建工具，推荐入口）
|
||
- `get_skill_by_datasource` - 获取技能信息
|
||
- `get_skill_tools` - 获取技能工具列表
|
||
- `create_sql_tool` - 创建 SQL 工具（需技能已存在）
|
||
- `delete_skill_tool` - 删除技能工具
|
||
- `update_skill_config` - 更新技能配置
|
||
- `update_skill_tool` - 修改技能工具
|
||
|
||
### 数据导入
|
||
- `preview_import_data` - 预览导入数据
|
||
- `confirm_import_data` - 确认导入数据
|
||
|
||
### 表订阅与 SQL 执行
|
||
- `toggle_table_subscription` - 切换表订阅
|
||
- `execute_sql` - 执行 SQL 查询
|
||
|
||
## 架构
|
||
|
||
- `tools/_base.py` - 工具注册装饰器和基类
|
||
- `tools/*.py` - 工具实现文件
|
||
- `utils/api_client.py` - 统一 HTTP 客户端
|
||
- `utils/env_config.py` - 环境变量配置
|
||
- `utils/logger_config.py` - 日志配置
|
||
- `server.py` - MCP Server 注册和启动逻辑
|