article
README
🚀 Clickzetta 为 Claude 桌面端服务器安装指南
本指南将详细介绍如何为 Claude 桌面端安装 Clickzetta 服务器,提供了多种安装方式及相关配置说明,同时介绍了其功能特性、示例查询、安全注意事项和常见问题解答。
🚀 快速开始
你可以选择不同的方式安装 Clickzetta 服务器,以下为你详细介绍各种安装方法。
📦 安装指南
安装方式概述
1. 使用 Smithery 自动化安装(此方法待测试验证)
可通过 Smithery 自动安装 Clickzetta Server,执行以下命令:
npx -y @smithery/cli@latest install @yunqiqiliang/mcp-clickzetta-server --client claude --key ******
2. 使用 UVX 手动安装(此方法待测试验证)
在 claude_desktop_config.json 中添加服务器,将以下内容添加到该文件:
# 将以下内容添加到您的 claude_desktop_config.json 文件中
"mcpServers": {
"clickzetta_pip": {
"command": "uvx",
"args": [
"mcp_clickzetta_server",
"--service",
"the_service", # 替换为实际服务名
"--instance",
"the_instance", # 替换为实际实例名
"--vcluster",
"the_vcluster", # 替换为实际 vcluster 名
"--workspace",
"the_workspace", # 替换为实际工作区
"--schema",
"the_schema", # 替换为实际模式名
"--user",
"the_user", # 替换为实际用户名
"--password",
"their_password" # 替换为实际密码
# 可选参数:
# --allow_write (不推荐使用)
# --log_dir, "/absolute/path/to/logs"
# --log_level, "DEBUG"/"INFO"/"WARNING"/"ERROR"/"CRITICAL"
# --exclude_tools, "{tool name}", ["{其他工具名}"]
]
}
}
使用 UV 命令行工具安装
在终端中执行以下命令:
uv --directory /Users/your_username/Documents/GitHub/mcp-clickzetta-server run mcp_clickzetta_server
配置说明
- 打开 Claude 桌面端,进入设置 → MCP 服务器。
- 添加一个新的服务器配置:
{
"mcpServers": {
"clickzetta-mcp-server" : {
"command": "/Users/your_username/anaconda3/bin/uv",
"args": [
"--directory",
"/Users/your_username/Documents/GitHub/mcp-clickzetta-server",
"run",
"mcp_clickzetta_server"
]
}
}
}
- 保存配置。
使用环境变量配置
将以下内容添加到您的 .env 文件中:
# 示例 .env 配置文件
SERVICE_NAME=your_service_name
INSTANCE_NAME=your_instance_name
VCENTER_NAME=your_vcenter_name
WORKSPACE_NAME=your_workspace_name
SCHEMA_NAME=your_schema_name
DB_USER=your_database_user
DB_PASSWORD=your_database_password
✨ 主要特性
- 只读操作:仅允许执行 SELECT 语句。
- 结果集限制:自动添加 LIMIT 子句以防止大数据量返回。
- 服务账户认证:通过服务账户进行安全连接。
- 输入验证:防止 SQL 注入攻击。
💻 使用示例
基础用法
查询基本配置
clickzetta-mcp-server --schema your_schema --user your_user --password your_password
示例输出
{
"status": "success",
"result": {
"data": [
{
"column1": "value1",
"column2": "value2"
}
],
"rowCount": 10,
"columns": ["column1", "column2"]
}
}
⚠️ 安全注意事项
- 配置文件保护:确保
.env文件安全,避免泄露数据库凭据。 - 网络访问控制:限制服务器的网络访问范围。
❓ 常见问题
- 无法连接到数据库?
- 检查数据库服务是否可用。
- 确认凭据信息正确无误。
- 返回结果为空?
- 检查查询语法是否正确。
- 确保有足够的权限执行查询。
扫码联系在线客服