Svelte定义协议服务

提供权威的Svelte 5和SvelteKit定义,直接从TypeScript声明中提取,通过统一接口获取精确的语法、参数和示例。

  • by spences10
  • TypeScript
  • 本地部署
  • 123 星标
  • 更新于
在 GitHub 查看 spences10/mcp-svelte-docs

使用说明

mcp瘦文档

提供权威Svelte 5的模型上下文协议(MCP)服务器 以及直接从TypeScript中提取的SvelteKit定义 声明。获取所有内容的精确语法、参数和示例 通过一个统一的界面提供5个概念。

建筑

定义优先法:与其使用多种专用工具, 该服务器提供了一个强大的 svelte_definition 工具 访问28个以上的综合定义,包括:

  • 所有 Svelte 5 runes ($状态、$派生、$道具、$效果变体)
  • 现代特征 (代码片段、等待表达式、远程函数)
  • 事件处理 (DOM事件、自定义事件、组件 通信)
  • 迁移指导 (提供4到5种模式和最佳实践)
  • TypeScript接口 (片段、快照类型)
  • 高级图案 (全局状态、常见错误、生命周期 等效物)

可用工具

svelte_definition

单一、强大的工具 对于所有Svelte 5和SvelteKit概念:

svelte_definition(identifier: string, format?: "syntax"|"quick"|"full")

示例:

  • svelte_definition("$state") -完成$state文档
  • svelte_definition("snippets", "quick") -片段概述 例子
  • svelte_definition("onclick", "syntax") -只有TypeScript 签名
  • svelte_definition("migration-patterns") -Svelte 4→ 5 迁移 指南

响应格式:

  • "syntax" -仅支持TypeScript签名(约50个单词)
  • "quick" -定义+最小示例(约200字)
  • "full" -完整的文档和示例(~500-1000字, 默认)

可用标识符(28+)

核心符文: $state, $state.raw, $state.snapshot, $derived, $derived.by, $props, $bindable, $effect, $effect.pre, $effect.root, $effect.pending, $effect.tracking

开发工具: $inspect, $host

特征和图案: snippets, onclick, component-events, migration-patterns, await-expressions, remote-functions, global-state, common-mistakes, lifecycle-equivalents

事件处理: custom-events, event-delegation, event-modifiers

TypeScript接口: snippet, snapshot

主要特点

🎯 权威和TypeScript优先

  • 直接来源:定义摘自Svelte 5官方 TypeScript声明
  • 始终为最新:反映了实际的API,而不是过时的教程
  • 类型安全:包括精确的参数类型、返回值和 约束

⚡ 单一界面,全面覆盖

  • 一个工具: svelte_definition 替换16+专用工具
  • 28+定义:每个Svelte 5符文、特征和图案 覆盖的
  • 一致的响应:无论您是否需要,界面都是一样的 $state 或 remote-functions

🚀 现代Svelte 5和SvelteKit支持

  • 等待表达:直接在模板中异步操作 (await-expressions)
  • 远程功能:类型安全的客户端-服务器通信 (remote-functions)
  • 所有符文:完成 $effect 家庭, $state 变体, $derived.by, $bindable
  • 高级模式:事件处理、全局状态、组件 沟通

📚 智能错误恢复

  • 模糊匹配:建议拼写错误的正确标识符
  • 相关概念:搜索时指向类似的定义 失败
  • 迁移帮助将 Slilte 4 模式转换为 Slilte 5 等价物

配置

克劳德桌面(通过WSL)

{
	"mcpServers": {
		"mcp-svelte-docs": {
			"command": "wsl.exe",
			"args": ["bash", "-c", "npx -y mcp-svelte-docs"]
		}
	}
}

光标

风帆冲浪(通过WSL)

{
	"mcpServers": {
		"mcp-svelte-docs": {
			"command": "wsl.exe",
			"args": ["bash", "-c", "npx -y mcp-svelte-docs"]
		}
	}
}

Windows(不带WSL)

{
	"mcpServers": {
		"mcp-svelte-docs": {
			"command": "npx",
			"args": ["-y", "mcp-svelte-docs"]
		}
	}
}

macOS/Linux

{
	"mcpServers": {
		"mcp-svelte-docs": {
			"command": "npx",
			"args": ["-y", "mcp-svelte-docs"]
		}
	}
}

贡献

欢迎投稿!请随时提交拉取请求。

许可证

MIT许可证-请参阅 许可证 文件以获取详细信息。

致谢

构建于: