外部工具

注册可执行文件、文本过滤器、REST API和MCP服务器。

选择集成方式

类型用途
可执行文件(不等待)启动其他应用,不等待其结束,也不收集其输出
标准输入输出过滤器把文本传给程序,并取回转换后的结果
REST API(HTTP POST)发送JSON并取回响应正文
MCP客户端调用MCP服务器上的工具并取回回复文本

注册并运行工具

  1. 选择设置 → 外部集成 → + 添加工具。
  2. 输入名称,选择工具类型,并填写该类型所需的字段,例如可执行文件路径或终结点URL。
  3. 如果工具接收文本,请选择要发送的输入。如果工具返回结果,请选择输出的处理方式。
  4. 根据需要设置仅在有打开的文件时执行和仅在有选中文本时执行。
  5. 保存设置,然后在终端中运行/<工具名称>。

也可以通过格式工具栏上的插头图标运行工具。每个已注册的工具都会出现在快捷键和手势设置选项卡中,你可以在那里为它分配快捷键或手势。

把当前文档传给工具

在参数等位置使用下列占位符。

占位符内容
{file} / {dir}文件路径,以及包含该文件的文件夹
{selection}选中的文本
{workspace}工作区的根目录
{input}在终端中工具名称后输入的内容
{full_document}整个文档。可用于REST的Body和MCP的参数JSON
{token}已注册的令牌。可用于REST的Headers和Body,以及MCP的参数JSON

在JSON中,请使用以_json结尾的占位符。它们会对引号和换行进行转义,并带上两侧的引号,因此结果是合法的JSON字符串。不要在占位符外面再加一对引号。

{"text": {selection_json}, "instruction": {input_json}}

各类型的检查要点

  • 标准输入输出过滤器:选择要输入的内容,例如选中的文本、整个文档或终端参数。检查可执行文件的路径和工作目录。
  • REST API:外部终结点必须使用HTTPS。响应正文按原样取回,因此无法从JSON中只提取某一个字段。注册令牌时,请使用设置令牌…。
  • MCP:使用标准输入输出时,填写命令、参数和环境变量;使用HTTP时,填写终结点。然后设置工具名称和参数JSON。要使用npx或uvx,请另行安装它们所需的运行时。

选择结果的去向

结果可以替换选中的文本、插入到光标处、替换整个文档、复制到剪贴板、作为新文件保存,或显示在终端中。替换整个文档后不会自动保存,请在保存前检查结果。

运行开始后切换标签页,输出也不会随之移动:它会应用到开始运行时所在的标签页。如果该标签页已关闭,输出会在新标签页中打开。正在进行的运行可以在进度窗口或终端中取消。

把工具定义迁移到另一台电脑

在“外部集成”选项卡中使用导出到 JSON… / 从 JSON 导入…。导入之前,请检查可执行文件路径和URL。令牌的值不会被导出,请在另一台电脑上重新注册。

许可证不允许编辑时无法运行外部工具。请在许可证与激活中查看状态。

快捷键按默认分配列出。如果你更改过分配,请在应用内帮助(F12)中查看当前的按键。