跳到主要内容

AI 工具

Skills

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

运行以下命令安装 skill:

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

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

使用 skills

Skills 会在 agent 判断其匹配当前任务时自动加载。若要确保某个 skill 被使用,可显式调用它:

  • Claude Code 中:在提示词开头添加 /svar-svelte
  • OpenAI Codex CLI 中:在提示词开头添加 $svar-svelte

不支持 skill 的工具的平铺上下文文件

如果您使用的工具不原生支持 skill,例如 ChatGPT、GitHub Copilot 或基于浏览器的操作界面,guides 文件夹提供了与 skill 相同内容的纯 Markdown 文件,可供粘贴或附加:

  • svar-svelte-editor.md — editor 包的上下文
  • svar-svelte-all.md — 所有包的合并上下文

MCP

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

SVAR MCP

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

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

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

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

启用后,您的 AI agent 可向我们的服务器"请求"帮助,确保为您生成的代码准确、及时,并遵循我们推荐的模式。

服务器 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

Gemini CLI

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

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

也可以手动配置:

  1. 找到配置文件,通常位于 ~/.gemini/settings.json
  2. 将服务器添加到 mcpServers 对象中:
{
"mcpServers": {
"svar-mcp": {
"url": "https://docs.svar.dev/mcp"
}
}
}
  1. 重启 Gemini CLI。

详情请参阅官方文档

Antigravity (Google)

对于 Google 的 Antigravity agent:

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

更多指导请参阅官方文档

其他 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 完成

现在您可以在询问有关 Svelte Editor 的问题时,要求您的 Custom GPT "Consult the SVAR MCP server"。

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