跳到主要内容

AI 工具

Skills

SVAR skills 适用于支持 SKILL.md 规范的 AI 编码代理,包括 Claude Code、Cursor、OpenAI Codex CLI 和 Gemini CLI。

运行以下命令安装 skill:

npx skills add svar-widgets/skills --skill svar-vue

您也可以从 skills 仓库 手动下载 skill 文件夹。

使用 skills

Skills 会在代理判断其与任务匹配时自动加载。要确保使用某个 skill,可以显式调用它:

  • Claude Code 中:以 /svar-vue 开头输入提示
  • OpenAI Codex CLI 中:以 $svar-vue 开头输入提示

其他工具的平面上下文文件

如果您使用的工具不原生支持 skill(如 ChatGPT、GitHub Copilot 或基于浏览器的 playground),guides 文件夹 提供了与 skill 相同的上下文,以普通 Markdown 文件形式供您粘贴或附加:

  • svar-vue-editor.md — 编辑器包的上下文
  • svar-vue-all.md — 所有包的完整上下文(合并为一个文件)

MCP

在现代开发环境中,AI 自动化工具已成为高效编码和解决问题的必备工具。为此,我们提供专用资源,帮助 AI 代理更好地理解和使用我们的产品。

SVAR MCP

目前,我们提供一个 Model Context Protocol (MCP) 服务器,可将您的 AI 助手直接连接到我们的最新文档和代码示例。

SVAR MCP 服务器充当文档与 AI 编码工具之间的桥梁。大型语言模型(LLM)通常存在训练数据截止日期,这意味着它们可能不了解我们库的最新特性、API 变更或最佳实践。

我们的 MCP 服务器通过以下方式解决这一问题:

  • 最新文档: 实时访问我们文档的最新版本。
  • 基于 RAG 的解决方案: 自定义检索增强生成(RAG)方案,可根据您的具体查询找到相关信息并生成精确的代码片段。

启用后,您的 AI 代理可以向我们的服务器"提问",确保为您生成的代码准确、最新,并遵循我们推荐的模式。

服务器 URL: https://docs.svar.dev/mcp

托管服务

SVAR MCP 服务器作为完全托管的云服务提供。由于其高资源需求和无状态特性(不访问或存储本地用户数据),该服务器不支持本地部署。

该服务不存储 MCP 用户的任何个人信息。但发送至服务器的查询可能会被存储,用于调试和服务改进。如果您希望退出此项目,请通过 info@svar.dev 联系我们,我们可以为您提供保证零日志策略的商业版本。

集成指南

以下是在主流 AI 编码工具中启用 SVAR MCP 服务器的说明。

Claude Code

要在 Claude Code 中使用 MCP 服务器,可以通过命令行添加,或在项目设置中进行配置。

使用 CLI:

在终端运行以下命令:

claude mcp add --transport http svar-mcp https://docs.svar.dev/mcp

手动配置:

您也可以将其添加到 ~/.claude.json.mcp.json 配置文件中:

{
"mcpServers": {
"svar-mcp": {
"type": "http",
"url": "https://docs.svar.dev/mcp"
}
}
}

更多信息请参阅官方文档

Cursor

Cursor 内置了对 MCP 服务器的支持。

  1. 打开 Cursor Settings(Cmd+Shift+J 或 Ctrl+Shift+J)。
  2. 导航至 Tools & MCP
  3. 点击 Add Custom MCP
  4. 输入服务器配置:
{
"mcpServers": {
"svar-mcp": {
"url": "https://docs.svar.dev/mcp"
}
}
}

添加后,您可以在对话中引用它(例如:"Check SVAR Docs for how to configure the editor")。

您也可以一键在 Cursor 中直接安装 SVAR MCP 服务器:

Install MCP for Cursor

详情请参阅官方文档

VS Code

点击按钮直接在 VS Code 中安装 SVAR MCP 服务器:

Install MCP for VS Code

Google Antigravity

Antigravity 2.0

信息

更多指导请参阅官方文档

按照以下步骤操作:

  1. 打开命令面板,输入 "mcp add"
  2. 选择 "HTTP"
  3. 输入 URL https://docs.svar.dev/mcp
  4. 输入 Name svar-mcp

Antigravity CLI

信息

请查阅相关指南,了解从 Gemini CLI 迁移到 Antigravity CLI 的相关内容。

要在 Antigravity CLI 工具中使用该服务器:

agy mcp add --transport http svar-mcp https://docs.svar.dev/mcp

或者,您也可以手动配置:

  1. 在以下位置之一创建 MCP 配置文件:
    • 全局: ~/.gemini/config/mcp_config.json
    • 工作区: .agents/mcp_config.json
  2. 将服务器添加到 mcpServers 对象中:
{
"mcpServers": {
"svar-mcp": {
"serverUrl": "https://docs.svar.dev/mcp"
}
}
}
  1. 在终端运行 agy

其他 IDE / 工具

  1. 在设置中查找 Model Context ProtocolContext Sources
  2. 添加一个新的自定义来源,URL 为 https://docs.svar.dev/mcp

ChatGPT

要在 ChatGPT 中启用该服务器:

  1. 打开 ChatGPT,导航至 Settings / Apps & Connectors
  2. 点击 Advanced settings
  3. 启用 Developer mode
  4. 返回上一级,此时 "Connectors" 页面会出现 "Create" 按钮,点击它。
  5. 输入 Name svar-mcp
  6. 输入 URL https://docs.svar.dev/mcp
  7. Authentication 选择为 No authentication
  8. 点击 Create 完成设置

现在,您可以在询问有关 Vue Editor 的问题时,让您的自定义 GPT "Consult the SVAR MCP server"。

完整的设置详情请参阅官方文档