关于 SvGrid
@svgrid/mcp 是面向 Svelte 5 网格开发者的官方 SvGrid MCP 服务,提供按版本固定的文档和示例。它还能依据已安装的 API 和 Svelte 编译器检查代码。
主要功能
- 01一并搜索文档、示例和 API
- 02读取完整文档和示例源码
- 03依据已安装的 API 检查代码
- 04使用 Svelte 编译器编译代码
- 05在对话中预览交互式网格
- 06搭建或生成 SvelteKit 项目
适用场景
- 01查找正确的 SvGrid 属性或方法
- 02检查网格代码中的 API 不匹配
- 03检查 Svelte 5 语法和编译错误
- 04使用 Studio 构建可运行的 SvelteKit 应用
MCP 相关
它将工具、文档和示例源码作为 MCP 资源提供,并附带用于创建网格、解释 API 和审查代码的提示词。支持 stdio 和托管的 Streamable HTTP 端点;Studio 与脚手架工具需选择启用或仅限本地使用。
配置
远程服务无需本地安装。选择你使用的客户端,复制配置或使用一键安装。
https://mcp.svgrid.com/mcpclaude mcp add --transport http com-svgrid-svgrid https://mcp.svgrid.com/mcp{"mcpServers":{"com-svgrid-svgrid":{"type":"http","url":"https://mcp.svgrid.com/mcp"}}}在 Cursor 中打开{"servers":{"com-svgrid-svgrid":{"type":"http","url":"https://mcp.svgrid.com/mcp"}}}在 VS Code 中打开{"mcpServers":{"com-svgrid-svgrid":{"type":"http","url":"https://mcp.svgrid.com/mcp"}}}{"mcpServers":{"com-svgrid-svgrid":{"serverUrl":"https://mcp.svgrid.com/mcp"}}}命令在终端中运行;JSON 粘贴到对应客户端的 MCP 配置后重启。需要授权的服务会在首次连接时提示登录。
工具
6| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| limit | number | 否 | 最大结果数,默认值为 10,最大值为 25。 |
| query | string | 是 | 要查找的内容,例如 "row virtualization"。 |
详细介绍
@svgrid/mcp
SvGrid 官方 Model Context Protocol 服务。
将任何支持 MCP 的客户端(Claude Desktop、Claude Code、Cursor、Zed)连接到此服务,模型就能给出关于 SvGrid 的准确且与版本对应的信息:真实的属性、方法和事件名称,以及每个示例的源代码作为依据。没有虚构的 API,也没有过时的博客文章。
为什么这比把文档粘贴到聊天中更好。 依赖记忆工作的模型会编造看似合理的 SvGrid API,因为它学习时混合了其他网格组件和旧版本的内容。粘贴文档有助于回答一个问题,但随后就会超出上下文窗口。此服务让当前 API 面和每个可运行示例的源代码都能通过一次工具调用获取,并适用于每个问题,且内容固定为你安装的版本。
提供的工具
共五个。每次请求都会发送 tools/list,因此工具面在每轮对话中都是纯开销——此服务过去会在 36 个工具上花费约 4,710 个 token,其中 79% 是大多数会话中一次也不会调用的 Studio 工具。
| 工具 | 用途 |
|---|---|
svgrid_search | 一次调用即可搜索文档、所有示例和 API 面。不带参数时返回索引。 |
svgrid_get | 完整读取一项内容:文档 slug、示例 id 或 api。 |
svgrid_check_code | 根据真实 API 面和 Svelte 编译器验证文件。 |
svgrid_preview | 在对话中从列和行渲染实时交互式网格(MCP Apps)。 |
svgrid_scaffold | Studio:将 Drizzle 架构、示例行或 EntitySchema 转换为可运行的 SvelteKit 文件。 |
文档和示例也会作为 MCP 资源提供(svgrid://doc/<slug>、svgrid://example/<id>),并附带四个可直接运行的提示词:build_grid、build_sheet、explain_api、review_grid_code。
所有 3.0 之前的工具名称仍然可用:search_docs、get_doc、list_examples、get_example_source、list_docs、get_api_reference、check_svgrid_code、introspect_source、scaffold_entity,以及全部 27 个独立的 studio_* 工具。它们不会列出,因为列出工具会消耗上下文,而响应未公开列出的名称不花费任何成本。它们的响应格式遵循 3.0。
svgrid_check_code - 检索服务无法做到的事
阅读文档会让模型更有可能答对。这个工具则让答案可检查。 传入一个文件,它会返回带行号的诊断信息,以及每项问题的精确 替换内容:
{
"ok": false,
"checkedAgainst": "@svgrid/[email protected]",
"compiler": "svelte",
"counts": { "errors": 3, "warnings": 0, "info": 0 },
"diagnostics": [
{ "rule": "svgrid/renamed-prop", "severity": "error", "line": 24,
"message": "`rowData` is not a SvGrid prop.", "fix": "Use `data`." },
{ "rule": "svgrid/renamed-column-key", "severity": "error", "line": 10,
"message": "`accessorKey` is not a SvGrid column key.", "fix": "Use `field`." },
{ "rule": "svelte/legacy-event-directive", "severity": "error", "line": 30,
"message": "`on:rowClick` never fires: SvGrid dispatches no component events, it takes callback props.",
"fix": "Use `onRowClick={...}`." }
]
}
检查内容:
- 每个名称,并针对已安装的版本。 可导入的符号、
<SvGrid>属性、ColumnDef键、网格 API 方法、主题样式表。该列表在构建时 根据包源码生成,因此不会偏离包实际导出的内容;遇到未知名称时,会返回最接近的 真实名称。 - 跨包错误。 例如,某个符号实际属于
@svgrid/enterprise,或者某个 API 方法只有在调用installEnterprise(api)后才存在。 - Svelte 5 规则。 在 runes 文件中使用
export let和$:(编译器错误)、on:/<slot>/createEventDispatcher(弃用),以及普通的let数组被修改后却悄无声息地不再触发重新渲染。 - 编译文件。 如果能找到 Svelte 编译器,会优先使用用户项目中的副本,
然后使用此处随附的版本;真正的解析错误也会一并返回。结果会在
compiler字段中注明运行的是哪个编译器,因此“没有错误”绝不会被误认为 “可以编译”。
该工具经过调校,代码正确时不会乱报:仓库中的所有示例都不会收到任何报告, 这一点由 CI 测试断言。会误报的验证器还不如没有,因为模型很可能会“修复”正常工作的代码。
Studio:驱动应用模型(Agent 协同设计)
studio_* 工具让 Agent 能够构建和编辑与可视化设计器使用的同一套经过验证的项目模型——添加实体、屏幕、区块、组件,连接数据源,配置主题、RBAC、身份验证、类型化数据层和部署目标,然后生成完整的可运行应用,或导出设计器可以加载的 studio.config.json。每项编辑都会调用模型自身的函数和 validateProject,因此 Agent 无法生成无效应用。
选择启用。 在服务的环境变量中设置 SVGRID_MCP_STUDIO=1,或设置有效的
SVGRID_LICENSE_KEY。需要许可证才有用的工具,不应在每次请求中消耗其他
用户的上下文。
这些工具和 svgrid_scaffold 运行于 @svgrid/enterprise,这是一个可选的
peer 依赖,npx -y @svgrid/mcp 不会安装它(否则冷启动时间会翻倍)。
请在项目中安装这两个包,并运行本地服务:
npm i -D @svgrid/mcp @svgrid/enterprise
claude mcp add svgrid -- npx svgrid-mcp
| 工具 | 用途 |
|---|---|
studio_project | new、load、describe、config、capabilities。 |
studio_apply | 按顺序批量应用模型变更:实体、屏幕、区块、组件。 |
studio_configure | 一次调用即可配置主题、身份验证、RBAC、多租户、数据层、作业、部署目标和布局。 |
studio_build | 先执行 validate,再执行 generate,生成完整的可运行 SvelteKit 应用。 |
典型会话:studio_project(new)→ 每个屏幕执行一次 studio_apply
批量操作 → studio_configure → studio_build(generate)→ 写入文件并
运行 svelte-check。
studio_apply 有意采用批量操作。此前,27 个每次只能修改一项的工具,会让一个
五屏应用需要二十多次往返;现在,整个屏幕只需一次调用,发生失败时会报告失败的操作
以及已应用的内容。
两种运行方式
| stdio(此软件包) | 远程 HTTP | |
|---|---|---|
| 安装 | npx @svgrid/mcp | https://mcp.svgrid.com/mcp |
| 需要 Node | 是 | 否 |
svgrid_check_code 编译代码 | 是 | 仅静态检查 |
Studio studio_* 工具 | 是(可选启用) | 否 |
| 可离线使用 | 是 | 否 |
# No install: point any MCP client at the hosted server
claude mcp add --transport http svgrid https://mcp.svgrid.com/mcp
远程服务已在 https://mcp.svgrid.com/mcp 上线,提供文档、验证和预览工具(源代码)。如果需要编译器处理流程、Studio 工具,或不想在流程中使用第三方端点,请使用 stdio。
运行
# One-shot via npx (no install)
npx @svgrid/mcp
# Or install globally, then run the bin
npm install -g @svgrid/mcp
svgrid-mcp
该服务通过 stdio 使用 MCP 通信:stdout 专供 JSON-RPC 使用,日志则写入 stderr。
连接 Claude Desktop
编辑 ~/Library/Application Support/Claude/claude_desktop_config.json(macOS)或
%APPDATA%\Claude\claude_desktop_config.json(Windows):
{
"mcpServers": {
"svgrid": {
"command": "npx",
"args": ["-y", "@svgrid/mcp"]
}
}
}
重启 Claude Desktop 并开启新聊天,即可使用上述工具。
连接 Claude Code
claude mcp add svgrid -- npx -y @svgrid/mcp
然后在会话中运行 /mcp,确认列表中有 svgrid。可以询问类似
"使用 svgrid,构建一个按部门分组并在每行显示迷你趋势图的网格"
的问题,模型会在生成代码前提取相关演示源代码。
连接 Cursor / Zed
将相同的 mcpServers 配置块添加到编辑器的 MCP 配置中:
{
"mcpServers": {
"svgrid": { "command": "npx", "args": ["-y", "@svgrid/mcp"] }
}
}
从源代码构建
cd packages/mcp
pnpm build
node dist/index.js
pnpm build 会先运行 scripts/build-manifests.mjs,从工作区读取
examples/src/demos/*.svelte 和 docs/**/*.md,并将其内嵌到
src/data.ts 中,因此发布的软件包完全独立。
企业版功能
导出到 Excel 和 PDF、数据透视表、看板、调度器、电子表格和服务器端行模型均位于商业软件包 @svgrid/enterprise 中。回答会明确说明这一点:svgrid_search 结果中,付费文档或演示会带有 "enterprise": true;询问付费功能时,回答会提供一行试用链接;如果解决方案是安装该软件包,svgrid_check_code 也会附上相关信息。该软件包无需许可证密钥即可运行,但在设置密钥前会显示水印。30 天试用可下载所有演示,并提供 30 天电子邮件支持。
许可
MIT——可免费运行,无需许可证密钥。有些工具会生成 SvGrid Studio 项目,而 Studio 本身是商业产品;请参阅 svgrid.com/pricing。
MIT 许可的 @svgrid/grid 核心可免费用于任何用途。
SvGrid™ 和 sv-grid™ 是 jQWidgets Ltd. 的商标。
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。