用自然语言构建生产级集成与工具。

什么是 superglue？

• superglue 是一款基于 AI 的工具构建器，可与任何 API、数据库或文件存储服务器协同工作。
• 它抽象了身份验证、文档处理以及系统间的数据映射等复杂流程。
• 自我修复工具：当上游 API 发生变更导致步骤失败时，superglue 能够自动修复问题，确保您的工具持续运行。

人们用 superglue 构建什么？

• 轻量级且易于维护的数据同步工具，用于连接遗留系统。
• 在云迁移过程中，将复杂的 SQL 存储过程迁移到 REST API 调用。
• 企业级 GPT 工具：在企业内部的 GPT 系统中，暴露并使用能够与自定义遗留系统交互的工具。

快速入门

选项 1：注册 superglue 并立即开始构建

选项 2：自托管 以获得最大的控制权和定制能力。

接口

无论您是自托管还是使用托管版本，都可以通过三种接口与 superglue 交互：

Web 应用程序

• Web 应用程序适用于自托管和 superglue 托管两种部署方式。
• 如果选择 superglue 托管方案，Web 应用程序将提供自托管模式下不可用的功能（例如 superglue 代理）。
• 在本地开发自托管环境时，您可以根据需求自定义 Web 应用程序。

superglue SDK

• superglue SDK 提供对所有 superglue 数据类型的 CRUD 操作，并允许您以编程方式执行工具。

• 如需了解 SDK 功能的详细信息，请参阅我们的 SDK 指南。

  通过 npm 安装：

    npm install @superglue/client
  

  客户端设置：

  // TypeScript SDK
  import { SuperglueClient } from "@superglue/client";
  
  const superglue = new SuperglueClient({
    apiKey: "your_api_key_here", // 从 app.superglue.cloud 获取
  });
  

MCP 服务器

• 请参阅我们的 MCP 指南，获取完整的安装说明。
• MCP 界面为您提供预构建 superglue 工具的发现工具和执行功能。
• MCP 不支持临时集成创建或工具构建。
• 在生产环境中，可以使用 MCP 进行代理型用例和内部 GPT 的部署，以完全可控的方式访问和执行预构建工具。

📖 文档

如需详细文档，请访问 docs.superglue.cloud。

🤝 贡献

我们非常欢迎贡献！在提交贡献之前，请所有用户阅读我们的 贡献指南，并签署贡献者许可协议 (CLA)。创建新问题或拉取请求时，请确保符合贡献指南的要求。

许可证

superglue 采用 FSL 许可证。superglue 客户端 SDK 则采用 MIT 许可证。详情请参阅 LICENSE。

后续步骤

• 加入我们的 Discord
• 阅读我们的文档
• 与我们联系

随时联系我们！

Superglue 快速上手指南

Superglue 是一款由 AI 驱动的工具构建平台，支持通过自然语言快速构建生产级的集成工具。它能自动处理认证、文档解析及系统间的数据映射，并具备“自愈”能力，可在上游 API 变更时自动修复故障。

环境准备

在开始之前，请确保满足以下要求：

• 操作系统：Linux、macOS 或 Windows（支持 Docker 环境）
• 运行时依赖：
  • Node.js (推荐 v18 或更高版本)
  • npm 或 yarn 包管理器
• 账户准备：
  • 若使用云端版：需注册 superglue.cloud 获取 API Key。
  • 若使用自托管版：需安装 Docker 和 Docker Compose。

提示：国内开发者若遇到 npm 下载缓慢，可临时切换至淘宝镜像源：

npm config set registry https://registry.npmmirror.com

安装步骤

你可以通过以下两种方式开始使用 Superglue：

方式一：使用云端服务（推荐新手）

无需安装，直接访问 superglue.cloud 注册并登录即可开始构建。

方式二：自托管部署（适合需要数据可控的场景）

参考官方 自托管文档 使用 Docker 部署。

安装客户端 SDK

无论采用哪种部署方式，均可通过 npm 安装官方 SDK 进行程序化调用：

npm install @superglue/client

基本使用

以下是使用 TypeScript/JavaScript SDK 连接 Superglue 并初始化客户端的最简示例：

1. 获取 API Key：登录 superglue.cloud 并在设置中复制你的 API Key。
2. 编写代码：

// Typescript SDK
import { SuperglueClient } from "@superglue/client";

const superglue = new SuperglueClient({
  apiKey: "your_api_key_here", // 替换为你从 app.superglue.cloud 获取的 API Key
});

// 示例：后续可在此处调用 superglue.tools.execute() 等方法运行已构建的工具
console.log("Superglue client initialized successfully.");

3. 运行项目：保存文件后运行你的 Node.js 项目即可连接服务。

---

进阶使用：

• Web 界面：直接在浏览器中通过自然语言描述需求来创建工具。
• MCP 服务器：若需在 Agent 或内部 GPT 中调用已构建好的工具，可配置 MCP 接口（详见 MCP 指南）。

更多详细文档请访问 docs.superglue.cloud。