SnapKit蓝图MCP
一个模型上下文协议(MCP)服务器,用于在架构指南和实现规则上进行语义搜索。部分 SnapKit 生态系统。
与SnapKit的关系
此MCP服务器旨在与 SnapKit,一个基于SvelteKit构建的人工智能辅助定制框架。虽然SnapKit提供了运行时体系结构(页面注册表、组件发现、状态共享),但此服务器公开了 建筑知识 AI代理。
当与Claude Code或其他MCP兼容工具集成时,AI助手可以查询实现模式、组件指南和架构决策,使他们能够生成遵循SnapKit约定的代码,而无需手动共享上下文。
请参阅 SnapKit MCP服务器生态系统 了解这如何适应更广泛的工具。
特性
- markdown文档的语义搜索
- 使用Google Gemini API嵌入生成
- 快速内存向量搜索
- 自定义文档的可配置内容目录
设置
- 安装依赖项:
npm install- 创建
.env使用您的配置文件:
GOOGLE_API_KEY=your_api_key_here
CONTENT_DIR=/path/to/your/docs # Optional- 生成嵌入:
npm run build:embeddings- 构建项目:
npm run build环境变量
| 变量 | 必填 | 描述 |
|---|---|---|
GOOGLE_API_KEY | 是 | 用于生成和查询嵌入的Google Gemini API密钥 |
CONTENT_DIR | 否 | 包含markdown文档的文件夹的路径。默认为 ./content |
EMBEDDINGS_PATH | 否 | 嵌入JSON文件的路径。默认为 ./embeddings/embeddings.json |
使用自定义内容目录
您可以指向任何包含markdown文件的文件夹:
# Using an environment variable
CONTENT_DIR=/path/to/snapkit/.blueprints npm run build:embeddings
# Or in your .env file
CONTENT_DIR=/path/to/snapkit/.blueprints文件夹必须存在,否则嵌入生成将失败并出现错误。
使用Claude代码
将此MCP服务器添加到您的Claude Code配置中(~/.config/claude-code/mcp_config.json):
{
"mcpServers": {
"snapkit-blueprint": {
"command": "node",
"args": [
"/path/to/snapkit-blueprint-mcp/dist/index.js"
],
"env": {
"GOOGLE_API_KEY": "your_api_key_here"
}
}
}
}或者,将其全球链接:
# In this repository
npm link
# Then in your MCP config:
{
"mcpServers": {
"snapkit-blueprint": {
"command": "npx",
"args": ["snapkit-blueprint-mcp"],
"env": {
"GOOGLE_API_KEY": "your_api_key_here"
}
}
}
}配置后,重新启动Claude Code。这 search_blueprint 工具将可用。
项目结构
├── content/ # Default markdown documentation
├── embeddings/ # Generated embeddings (auto-created)
├── scripts/ # Embedding generation script
└── src/ # MCP server and search logic