如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题
概览 智能体访问 ChatGPT 与 Codex 用户文档 使用场景

插件扩展程序

构建自然融入 ChatGPT 的插件,让用户像使用原生功能一样使用它们。

通过 OpenAI MCP 扩展程序,开发者可以将插件接入 ChatGPT 的侧边栏、编辑器和文件查看器等主要界面。

ChatGPT 免费版和 ChatGPT Go 用户即将可以在网页版中使用插件扩展程序。现有插件功能不受影响。仅 ChatGPT 桌面应用支持在编辑器中使用提及功能。

示意图展示了插件扩展程序在 ChatGPT 的侧边栏、设置、编辑器、对话和侧面板中的用法。

试用扩展程序

试用我们的综合示例插件 Bits & Bolts,了解各类扩展程序的用法。每当有新的扩展程序推出,我们都会更新这个插件。

开始构建

请前往 GitHub 代码仓库查看安装说明、SDK 示例和完整规范。

服务器准备就绪后,请先连接并测试插件,然后将插件打包以便分发。

扩展程序参考

扩展程序让用户可以在 ChatGPT 的不同界面中以新的方式使用您的插件。只需几行 SDK 代码,即可声明插件支持某个扩展程序。

扩展程序 用户可以执行的操作
侧边栏应用 从侧边栏打开您的应用,并以全屏方式使用。
对话面板 在对话旁边打开您的应用,一边工作,一边聊天。
插件设置 直接在 ChatGPT 中调整您的插件专属设置。
文件查看器和编辑器 在您提供的界面中打开支持的文件,在同一处读取文件、查看实时更新并保存更改。
显示模式 选择应用在 ChatGPT 对话中的显示位置和方式。
深层链接 直接跳转到侧边栏应用中的特定页面或条目。
扩展模型上下文 控制注解,并指定附加的上下文在编辑器中的显示方式。
扩展消息发送功能 将消息发送到当前对话。在桌面端或网页版的工作模式中,也可将消息发送到新对话。
编辑器中的提及功能 在 ChatGPT 桌面应用的编辑器中查找并选择插件中的内容。
扩展表单 请用户提供结构化输入或从图片中选择,再将用户的答复返回给您的工具。
插件入门引导 在新对话或现有对话中引导用户完成设置。

侧边栏应用

在全局侧边栏添加一个入口,让用户可以全屏打开您的 MCP App。

注册 MCP App 工具时,请将以下元数据作为 _meta 传入。将 ui://parts/library 替换为您已注册的 UI 资源 URI。

import type { OpenAIUiToolMetadata } from "@openai/mcp-extensions/server";

const toolMetadata = {
  ui: { resourceUri: "ui://parts/library" },
  "openai/ui": {
    entrypoints: [{ type: "global" }],
  } satisfies OpenAIUiToolMetadata,
};

使用 { type: "thread" } 可在对话的侧面板中添加入口。完整的注册示例请参阅入口指南。

文件查看器和编辑器

当用户打开扩展名受支持的文件时,在对话的侧面板中打开您的 MCP App。

在工具的 _meta 中配置文件入口,并指定查看器支持的文件扩展名。

import type { OpenAIUiToolMetadata } from "@openai/mcp-extensions/server";

const toolMetadata = {
  ui: { resourceUri: "ui://parts/viewer" },
  "openai/ui": {
    entrypoints: [{ type: "file", extensions: ["stl"] }],
  } satisfies OpenAIUiToolMetadata,
};

将 ui://parts/viewer 替换为您已注册的 UI 资源。应用会收到已打开文件的资源 URI。按照文件处理程序指南接收该 URI,并使用应用 SDK 读取资源。

扩展表单

使用 ChatGPT 原生组件,为标准 MCP 表单提供更丰富的交互方式。

定义扩展表单模式
import type {
  OpenAIForm,
  OpenAIFormOption,
} from "@openai/mcp-extensions/server";

function partSelectionSchema(parts: OpenAIFormOption[]): OpenAIForm {
  return {
    type: "object",
    properties: {
      part: {
        type: "string",
        title: "Part",
        oneOf: parts,
      },
    },
    required: ["part"],
  };
}

在表单请求中,将此模式作为 requestedSchema 传入。每个选项都使用 const 和 title,还可以通过 x-openai-thumbnail 指定图标。在 OpenAI 注册的 MCP 服务器必须使用多轮往返请求(MRTR)。

扩展程序的实际应用

看看您熟悉的插件如何使用扩展程序。

Canva

侧边栏标签页让 Canva 用户可以直接在 ChatGPT 原生侧边栏中创建和预览设计作品。

查看插件

Figma

编辑器中的提及功能让 Figma 用户可以直接在 ChatGPT 桌面应用中搜索并提及文件。

查看插件

Adobe

文件扩展名处理程序让 Adobe 用户可以直接在 ChatGPT 中使用 Acrobat 和 Photoshop 编辑文件。

查看插件