README
🚀 Scalekit MCP 服务器
Scalekit MCP 服务器是一款强大的工具,它基于模型上下文协议(MCP),为管理 Scalekit 环境、组织、用户、连接和工作区操作提供了全面的支持。开发者可以借助该服务器,通过简单的自然语言查询,将自己的 AI 工具与 Scalekit 的上下文和功能相连接。
🚀 快速开始
Scalekit MCP 服务器能够让 AI 助手通过一套标准化工具与 Scalekit 的身份和访问管理平台进行交互。它提供了安全的、由 OAuth 保护的访问方式,可用于管理环境、组织、用户、认证连接等。
✨ 主要特性
- 环境管理与配置
- 组织和用户管理
- 工作区成员管理
- OIDC 连接设置与管理
- MCP 服务器注册与配置
- 角色和范围管理
- 管理门户链接生成
📦 安装指南
配置说明
根据你的 MCP 主机,以下是将 Scalekit 添加为 MCP 服务器的配置说明:
VS Code(版本 1.101 或更高)
| 使用 OAuth | 使用 mcp - remote 代理 | | ---- | ---- | |
{
"servers": {
"scalekit": {
"type": "http",
"url": "https://mcp.scalekit.com/"
}
}
}
|
{
"mcpServers": {
"scalekit": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.scalekit.com/"]
}
}
}
|
Claude Desktop
配置 Claude 应用以使用 MCP 服务器:
- 打开 Claude Desktop 应用,转到“设置”,然后选择“开发者”。
- 点击“编辑配置”。
- 打开
claude_desktop_config.json文件。 - 将服务器配置复制并粘贴到现有文件中,然后保存。
- 重启 Claude。
{
"mcpServers": {
"scalekit": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.scalekit.com/"]
}
}
}
Cursor
配置 Cursor 以使用 MCP 服务器:
- 打开 Cursor,转到“设置”,然后选择“Cursor 设置”。
- 在左侧选择 MCP。
- 点击右上角的“添加新的全局 MCP 服务器”。
- 将服务器配置复制并粘贴到现有文件中,然后保存。
- 重启 Cursor。
{
"mcpServers": {
"scalekit": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.scalekit.com/"]
}
}
}
Windsurf
配置 Windsurf 以使用 MCP 服务器:
- 打开 Windsurf,转到“设置”,然后选择“开发者”。
- 点击“编辑配置”。
- 打开
windsurf_config.json文件。 - 将服务器配置复制并粘贴到现有文件中,然后保存。
- 重启 Windsurf。
{
"mcpServers": {
"scalekit": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.scalekit.com/"]
}
}
}
📚 详细文档
可用工具
环境管理
| 工具名称 | 描述 | 参数 | 权限范围 |
| ---- | ---- | ---- | ---- |
| list_environments | 列出所有可用环境 | 无 | 环境读取 |
| get_environment_details | 通过 ID 获取环境详细信息(例如,env_123) | environmentId | 环境读取 |
| list_environment_roles | 列出指定环境中的所有角色 | environmentId(格式:env_<number>) | 环境读取 |
| create_environment_role | 在指定环境中创建新角色 | environmentId(格式:env_<number>)、roleName、displayName、description、isDefault(布尔值) | 环境写入 |
| list_environment_scopes | 列出指定环境中的所有范围 | environmentId(格式:env_<number>) | 环境读取 |
| create_environment_scope | 在指定环境中创建新范围 | environmentId(格式:env_<number>)、scopeName、description | 环境写入 |
工作区管理
| 工具名称 | 描述 | 参数 | 权限范围 |
| ---- | ---- | ---- | ---- |
| list_workspace_members | 列出当前工作区中的所有成员 | pageToken(基于 1 的索引) | 工作区读取 |
| invite_workspace_member | 邀请新成员加入当前工作区 | email | 工作区写入 |
组织管理
| 工具名称 | 描述 | 参数 | 权限范围 |
| ---- | ---- | ---- | ---- |
| list_organizations | 列出指定环境下的所有组织 | environmentId(格式:env_<number>)、pageToken | 组织读取 |
| get_organization_details | 通过 ID 获取组织详细信息(例如,org_123) | environmentId(格式:env_<number>)、organizationId | 组织读取 |
| create_organization | 在指定环境下创建新组织 | environmentId(格式:env_<number>) | 组织写入 |
| generate_admin_portal_link | 为选定的组织生成管理门户的魔法链接 | environmentId(格式:env_<number>)、organizationId(例如,org_123) | 组织写入 |
| create_organization_user | 在选定的组织中创建新用户 | environmentId(格式:env_<number>)、organizationId、email、externalId、firstName、lastName、metadata(JSON 键值对) | 组织写入 |
| list_organization_users | 列出选定组织中的所有用户 | environmentId(格式:env_<number>)、organizationId、pageToken | 组织读取 |
| update_organization_settings | 更新组织的设置 | environmentId(格式:env_<number>)、organizationId、feature(功能对象的 JSON 数组) | 组织写入 |
连接管理
| 工具名称 | 描述 | 参数 | 权限范围 |
| ---- | ---- | ---- | ---- |
| list_environment_connections | 列出指定环境的所有连接 | environmentId(格式:env_<number>) | 环境读取 |
| list_organization_connections | 列出选定组织的所有连接 | environmentId(格式:env_<number>)、organizationId(例如,org_123) | 组织读取 |
| create_environment_oidc_connection | 为指定环境创建新的 OIDC 连接 | environmentId(格式:env_<number>)、provider(OKTA、GOOGLE、MICROSOFT_AD、AUTH0、ONELOGIN、PING_IDENTITY、JUMPCLOUD、CUSTOM、GITHUB、GITLAB、LINKEDIN、SALESFORCE、MICROSOFT、IDP_SIMULATOR、SCALEKIT、ADFS) | 环境写入 |
| update_environment_oidc_connection | 更新指定环境的现有 OIDC 连接 | environmentId(格式:env_<number>)、connectionId(例如,conn_123)、key_id、provider、oidc_config(全面的 OIDC 配置对象) | 环境写入 |
| enable_environment_connection | 启用指定环境的现有连接 | environmentId(格式:env_<number>)、connectionId(例如,conn_123) | 环境写入 |
MCP 服务器管理
| 工具名称 | 描述 | 参数 | 权限范围 |
| ---- | ---- | ---- | ---- |
| list_mcp_servers | 列出指定环境中的所有 MCP 服务器 | environmentId(格式:env_<number>)、pageToken | 环境读取 |
| register_mcp_server | 在指定环境中注册新的 MCP 服务器 | environmentId(格式:env_<number>)、name、description、url、access_token_expiry(秒)、provider(可选,当 use_scalekit_authentication 为 false 时必需)、use_scalekit_authentication(布尔值) | 环境写入 |
| update_mcp_server | 更新指定环境中的现有 MCP 服务器 | environmentId(格式:env_<number>)、id(MCP 服务器 ID)、name(可选)、description(可选)、url(可选)、access_token_expiry(可选,秒)、provider(可选)、use_scalekit_authentication(可选布尔值) | 环境写入 |
| switch_mcp_auth_to_scalekit | 将现有 MCP 服务器的认证方式切换为 Scalekit 认证 | environmentId(格式:env_<number>)、id(MCP 服务器 ID) | 环境写入 |
MCP 服务器认证
Scalekit MCP 服务器使用基于 OAuth 2.1 的认证方式。当你在 MCP 主机中注册 Scalekit MCP 服务器后,MCP 主机将启动 OAuth 授权流程,以便 MCP 客户端能够获取适当的令牌,从而与 Scalekit 的 MCP 服务器进行安全通信。
⚠️ 重要提示
如果你正在构建自己的 MCP 服务器并希望添加基于 OAuth 的授权,可以参考我们的 MCP 服务器认证解决方案:Auth for MCP Servers。
Scan to join WeChat group