Archiver
通过模型上下文协议(MCP)为AI编辑器规则集提供集中存储和管理系统。
概述
Archiveyr通过为AI编辑器指南、规则和指导文档提供单一的真实来源,解决了规则集重复和跨多个项目漂移的问题。只需存储一次规则集,即可在任何地方访问它们。
问题
在跨多个项目使用AI编辑器时,您通常需要在每个项目中复制相同的规则集(编码标准、样式指南、最佳实践)。这导致:
- 在多个地方保持相同规则的重复工作
- 随着规则集在项目中的不同演变而漂移
- 项目中AI编辑器行为的不一致性
解决方案
Archiveyr提供了一个集中式MCP服务器,将规则集存储在Valkey中,并使其可供任何兼容MCP的AI编辑器使用。创建一次规则集,在任何地方引用它。
特性
- 集中式存储:将规则集存储在Valkey支持的系统中
- MCP协议:通过模型上下文协议访问规则集
- 增删改查操作:创建、读取、更新和删除规则集
- 模式匹配:使用全局模式搜索和列出规则集
- 元数据跟踪:每个规则集的时间戳、标签和描述
- Docker分发:带有捆绑Valkey实例的自包含图像
- Snake案例命名:强制命名约定以保持一致性
快速开始
使用Docker(推荐)
# Pull and run the latest image
docker run -i ghcr.io/joebrinkman/archivyr:latest
# Or build locally
docker build -f docker/Dockerfile -t archivyr:latest .
docker run -i archivyr:latest从源头构建
# Install dependencies
go mod download
# Build binary
task build
# Run (requires Valkey running on localhost:6379)
./bin/archivyrMCP客户端配置
Claude桌面版
添加到您的Claude Desktop配置文件中:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
视窗: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"archivyr": {
"command": "docker",
"args": ["run", "-i", "ghcr.io/joebrinkman/archivyr:latest"]
}
}
}光标
添加到光标MCP配置中:
{
"mcpServers": {
"archivyr": {
"command": "docker",
"args": ["run", "-i", "ghcr.io/joebrinkman/archivyr:latest"]
}
}
}基罗
添加到Kiro MCP配置文件中:
工作空间级别: .kiro/settings/mcp.json
用户级: ~/.kiro/settings/mcp.json
{
"mcpServers": {
"archivyr": {
"command": "docker",
"args": ["run", "-i", "ghcr.io/joebrinkman/archivyr:latest"],
"disabled": false,
"autoApprove": []
}
}
}GitHub Copilot
添加到您的GitHub Copilot MCP配置中:
VS Code:设置→ 扩展→ GitHub Copilot→ MCP服务器
{
"github.copilot.advanced": {
"mcpServers": {
"archivyr": {
"command": "docker",
"args": ["run", "-i", "ghcr.io/joebrinkman/archivyr:latest"]
}
}
}
}帆板运动
添加到您的Windsurf MCP配置文件中:
macOS: ~/Library/Application Support/Windsurf/mcp_config.json
视窗: %APPDATA%\Windsurf\mcp_config.json
Linux: ~/.config/Windsurf/mcp_config.json
{
"mcpServers": {
"archivyr": {
"command": "docker",
"args": ["run", "-i", "ghcr.io/joebrinkman/archivyr:latest"]
}
}
}其他MCP客户端
Archiveyr使用stdio传输,并与任何兼容MCP的客户端配合使用。看 examples/mcp-config.json 更多配置示例。
使用示例
创建新规则集
使用 upsert_ruleset 在AI编辑器中创建新规则集的工具(所有字段都是必需的):
Create a new ruleset named "python_style_guide" with:
- Description: "Python coding standards for team projects"
- Tags: ["python", "style", "pep8"]
- Content: [your markdown content]该工具将自动检测到这是一个新的规则集并创建它。
更新现有规则集
使用 upsert_ruleset 更新现有规则集的工具(仅提供要更改的字段):
Update the ruleset "python_style_guide" with new description: "Updated Python standards"该工具将自动检测规则集是否存在,并仅更新提供的字段。
检索规则集
规则集作为MCP资源公开。通过URI引用它们:
ruleset://python_style_guide或者使用 get_ruleset 工具:
Get the ruleset named "python_style_guide"列出所有规则集
使用 search_rulesets 没有图案(或有图案)的工具 *):
List all available rulesets或者明确地:
Search for rulesets matching "*"搜索规则集
使用 search_rulesets 具有特定全局模式的工具:
Search for rulesets matching "*python*"
Search for rulesets matching "style_*"删除规则集
使用 delete_ruleset 工具:
Delete the ruleset named "old_ruleset"可用的MCP工具
upsert_ruleset:创建新规则集或更新现有规则集(自动检测要执行的操作)get_ruleset:按确切名称检索规则集delete_ruleset:按名称删除规则集search_rulesets:按名称模式搜索规则集,或在省略模式时列出所有规则集*
可用MCP资源
- URI方案:
ruleset://{name} - MIME类型:
text/markdown - 例子:
ruleset://python_style_guide
配置
通过环境变量进行配置:
VALKEY_HOST:Valkey主机(默认:localhost)VALKEY_PORT:Valkey端口(默认值:6379)LOG_LEVEL:记录详细程度(默认值:info)
建筑
Archiveyr的构建包括:
- 转到1.24+:核心实施
- 瓦尔基:键值存储后端
- 瓦尔基滑翔v2:成为Valkey的客户
- mcp走:MCP协议实施
- Valkey Docker镜像:官方Valkey形象为基础
数据存储
规则集以带有密钥模式的哈希值存储在Valkey中 ruleset:{name}:
Key: ruleset:python_style_guide
Fields:
description: "Python coding standards"
tags: ["python", "style", "pep8"]
markdown: "# Python Style Guide\n..."
created_at: "2025-10-28T10:30:00Z"
last_modified: "2025-10-28T15:45:00Z"发展
此项目使用 任务 用于构建自动化。先安装任务:
# macOS
brew install go-task
# Linux
sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin
# Or install via Go
go install github.com/go-task/task/v3/cmd/task@latest常见开发任务
# Set up development environment
task dev:setup
# Run tests (same as CI)
task test
# Run linter (same as CI)
task lint
# Build binary
task build
# Run full CI pipeline locally
task ci
# See all available tasks
task快速开发工作流程
# Before committing
task verify # Format, lint, and test
# Run tests quickly during development
task test:quick
# Watch for changes and auto-test (requires entr)
task dev:watch贡献
所有提交都必须包括DCO签核。使用 git commit -s 以自动添加签收。
许可证
BSD-3条款-见 许可证 了解详情。
