使用说明
DataSun CLI MCP服务器
该项目提供了 模型上下文协议(MCP)服务器 DataSun数据库安全套件命令行界面。它充当到本机CLI的桥梁,将其功能作为一组全面的 工具 它可以被任何兼容MCP的客户端调用。
这使得DataSunrise命令能够与AI助手和其他应用程序无缝集成,促进数据库安全管理的程序化和智能自动化。
特性
- MCP服务器: 实现模型上下文协议,以提供与DataSunrise交互的工具。
- 综合工具集: 将广泛的DataSunrise CLI命令作为MCP工具公开。
- TypeScript和SDK: 使用TypeScript构建,使用官方
@modelcontextprotocol/sdk. - 跨平台: 继承了Node.js的跨平台功能。
入门指南
先决条件
- Node.js 16.x或更高版本
- npm 8.x或更高版本
- Java运行时环境(JRE)11或更高版本。
- 具有CLI访问权限的现有DataSunrise安装。
安装
-
克隆存储库:
git clone https://github.com/datasunrise-github/datasunrise_mcp_cli.git cd datasunrise_mcp_cli -
安装依赖项:
npm install -
构建项目:
npm run build
用法
此服务器旨在与MCP兼容的客户端(如Claude、GPT模型或自定义应用程序)一起使用。
示例:在Windows上连接到克劳德桌面
以下步骤提供了 例子 用于将此服务器连接到Windows上的Claude Desktop客户端。
-
下载并安装Claude Desktop
- 从其安装应用程序 官方消息来源.
-
准备DataSunrise命令行界面
- 在某些环境中,您可能需要创建以下内容的副本
executecommand.bat作为dscli.bat:
cd "C:\Program Files\DataSunrise Database Security Suite\cmdline" copy executecommand.bat dscli.bat - 在某些环境中,您可能需要创建以下内容的副本
-
配置MCP客户端
- 您需要通过编辑客户端的JSON配置文件来配置客户端。
- 文件路径:
C:\Users\<YourUsername>\AppData\Roaming\Claude\claude_desktop_config.json - (注意:如果此文件不存在,则需要创建它。)
- 将以下JSON对象添加到文件中:
{ "mcpServers": { "datasunrise-cli-mcp": { "command": "node", "args": [ "C:\\Path\\To\\datasunrise_mcp_cli\\build\\src\\index.js", "--cli-path", "C:\\Program Files\\DataSunrise Database Security Suite\\cmdline\\dscli.bat" ], "env": { "DS_PASSWORD": "<your password (optional)>" } } } }- 重要:确保更换
C:\\Path\\To\\datasunrise_mcp_cli带有克隆存储库文件夹的实际路径。 - Windows/Nodist用户提示:如果你使用Node.js版本管理器,比如
nodist,它可能会干扰路径(如dscli.bat)阻止MCP服务器连接。为了解决这个问题,请提供完整、绝对的路径node.exe在"command"字段(例如。,"C:\\path\\to\\your\\node.exe"). - (注意:确切的JSON结构可能因客户端版本而异。)
-
运行并验证
- 打开克劳德桌面应用程序。
- 要验证连接,请导航到
File -> Settings -> Developer. - 状态为
datasunrise-cli-mcp应 “正在运行”.
MCP服务器正在运行
下面的屏幕截图显示了MCP客户端请求执行 instance_add_plus 命令。
DataSunrise MCP Server in Action
重要提示
- 始终允许使用安全工具:以下工具是只读的,可以安全地预先批准:
get_command_schema:检索命令的参数架构。set_cli_executable_path:设置路径dscli当前会话的可执行文件。get_enhanced_description:检索命令的增强文档。
- 仔细审查论点:在批准之前
run_cli_command执行时,始终检查参数以确保其正确。如果您发现任何不准确之处,请拒绝执行并向助理提供澄清细节。
可用工具
服务器提供了一组用于与DataSunrise CLI交互的核心工具,以及一组直接映射到CLI命令的全面工具。
核心工具
以下是与服务器交互的主要工具:
run_cli_command:执行DataSunrise CLI命令。执行前必须验证每个命令的参数。get_command_schema:检索特定CLI命令的输入架构。set_cli_executable_path:设置路径dscli当前会话的可执行文件,并对其进行验证。get_enhanced_description:检索命令的增强文档。
命令工具
服务器将全套DataSunrise CLI命令作为单独的MCP工具公开,这些工具按功能分组。这些工具是根据中的命令定义动态生成的 src/commands 目录。要执行命令,客户端应使用 run_cli_command 工具,在中传递所需命令的工具名称 command_name 参数及其参数 arguments 参数。
有关可用命令工具及其类别的完整列表,请参阅 src/commands一些可用的类别包括:
- 应用程序管理
- CEF配置
- 连接管理
- 核心功能
- 数据库用户管理
- 字典管理
- 数据发现
- …还有更多。
文档
有关详细的命令文档,请参阅:
DataSunrise_Database_Security_CLI_Guide.pdf(位于docDataSunrise安装目录的文件夹)。test/test-data/README.md有关测试数据结构的信息。
许可证
该项目是DataSunrise股份有限公司拥有的专有软件。
