🚀 土壤立方体 MCP 服务器
Terrakube MCP 服务器是一款用于与 Terrakube 平台集成的模型上下文协议 (MCP) 服务器。它提供了一系列 API 接口，可用于管理工作空间、变量、模块和组织等资源，为用户提供便捷的资源管理体验。
🚀 快速开始
Terrakube MCP 服务器提供了丰富的 API 接口，可用于管理工作空间、变量、模块和组织等资源。通过以下步骤，你可以快速配置和使用该服务器，并与 Claude Desktop 集成。
✨ 主要特性
- 工作空间管理：支持创建、更新、删除和获取工作空间。
- 变量管理：可对与工作空间相关的变量进行操作。
- 模块管理：能够处理模块的生命周期。
- 组织管理：实现组织的创建、更新和删除功能。
- 环境配置：可通过设置环境变量来配置服务器运行时参数。
📦 安装指南
环境变量配置
在项目根目录下创建一个 .env 文件，并添加以下变量：
TERRAKUBE_API_URL=
TERRAKUBE_PAT_TOKEN=
使用 Smithery 安装
通过 Smithery 自动安装 Terrakube MCP Server：
npx -y @smithery/cli install @AzBuilder/mcp-server-terrakube --client claude
开发流程
- 克隆仓库：
git clone https://github.com/azbuilder/terrakube-mcp-server.git
cd terrakube-mcp-server
- 安装依赖项：
npm install
- 构建项目：
npm run build
与 Claude Desktop 集成
在 claude_desktop_config.json 中添加以下配置：
{
"mcpServers": {
"terrakube": {
"command": "npx",
"args": [
"-y",
"@terrakube/mcp-server"
],
"env": {
"TERRAKUBE_API_URL": "" ,
"TERRAKUBE_PAT_TOKEN": ""
}
}
}
}
💻 使用示例
基础用法
以下是使用 Terrakube MCP Server API 进行工作空间管理的基础示例：
// 创建工作空间
createWorkspace(name: string, organization: string, description?: string) => WorkspaceDetails;
// 更新工作空间
updateWorkspace(workspaceId: string, name: string, organization: string, description?: string) => UpdatedWorkspace;
// 删除工作空间
deleteWorkspace(workspaceId: string) => boolean;
// 获取工作空间详情
getWorkspace(workspaceId: string) => WorkspaceDetails;
高级用法
在实际应用中，你可以结合多个 API 接口，实现更复杂的资源管理场景。例如，在创建工作空间后，立即为其创建相关变量：
// 创建工作空间
const workspace = createWorkspace('myWorkspace', 'myOrganization', 'This is a test workspace');
// 为工作空间创建变量
createVariable(workspace.id, 'myKey', 'myValue', 'This is a test variable');
📚 详细文档
API 接口参考
工作空间管理
- 创建工作空间
createWorkspace(name: string, organization: string, description?: string) => WorkspaceDetails;
- 更新工作空间
updateWorkspace(workspaceId: string, name: string, organization: string, description?: string) => UpdatedWorkspace;
- 删除工作空间
deleteWorkspace(workspaceId: string) => boolean;
- 获取工作空间详情
getWorkspace(workspaceId: string) => WorkspaceDetails;
变量管理
- 创建变量
createVariable(workspaceId: string, key: string, value: string, description?: string) => Variable;
- 更新变量
updateVariable(variableId: string, workspaceId: string, key: string, value: string, description?: string) => UpdatedVariable;
模块管理
- 创建模块
createModule(name: string, organization: string, provider: string, description?: string) => ModuleDetails;
- 更新模块
updateModule(moduleId: string, name: string, organization: string, provider: string, description?: string) => UpdatedModule;
组织管理
- 创建组织
createOrganization(name: string, description?: string) => OrganizationDetails;
- 更新组织
updateOrganization(organizationId: string, name: string, description?: string) => UpdatedOrganization;
📄 许可证
文档中未提及相关许可证信息。
项目徽章
通过以上步骤，您可以轻松配置和使用 Terrakube MCP Server，并与 Claude Desktop 集成。