使用说明
Grimoire MCP-开发模式库
当我提升自己的开发技能时，我总是需要一种方法来快速存储我最终在项目中实施的一些最佳实践。如果我的编码助理能把它保存给一些人呢。.. ✨ 模式库✨. 现在可以了！哦，它也可以读取代码模式！ 🥳
因此，Grimoire MCP是一个模型上下文协议（MCP）服务器，用于管理使用YAML frontmatter存储为markdown文件的软件开发模式。哦，这些都在你的文件系统上！
设置
所需环境变量
服务器 需要 这 PATTERNS_DIR 环境变量最好通过MCP配置或shell设置：
export PATTERNS_DIR="/path/to/your/patterns"
如果未设置此变量或目录不存在，服务器将无法启动。
图案文件格式
LLM将代表您创建模式，但也非常欢迎您自己存储它们。
模式存储为带有YAML frontmatter的markdown文件：
---
pattern: example-pattern
category: rust
framework: axum
projects: [project1, project2] # These are the names of the projects this pattern was involved in.
tags: [web, api, error-handling]
---
Your pattern content goes here...
用法
可用工具
list_patterns-列出所有可用模式search_patterns-按查询、类别、框架或标签搜索get_pattern-按名称获取特定图案create_pattern-使用元数据和内容创建新模式
图案浏览器TUI
该项目包括一个基于终端的模式浏览器(browse)作为单独的二进制目标。它允许您直接在终端中浏览、搜索和读取模式，而无需MCP客户端。
运行浏览器
PATTERNS_DIR="/path/to/your/patterns" cargo run --bin browse
或者构建并运行发布二进制文件：
cargo build --release
PATTERNS_DIR="/path/to/your/patterns" ./target/release/browse
键盘控制
| 关键 | 行动 |
|---|---|
j / ↓ |
向下导航 |
k / ↑ |
向上导航 |
/ |
搜索/过滤模式 |
Esc |
取消搜索 |
Enter |
应用搜索筛选器 |
PgUp / PgDn |
滚动图案内容 |
q |
退出 |
建筑
cargo build --release
这将生成两个二进制文件：
./target/release/grimoire-mcp--MCP服务器./target/release/browse--TUI模式浏览器
MCP客户端配置
Kiro命令行界面
添加到MCP配置中：
{
"mcpServers": {
"pattern-library": {
"command": "/path/to/grimoire-mcp/target/release/grimoire-mcp",
"env": {
"PATTERNS_DIR": "/path/to/your/patterns"
}
}
}
}
Cursor IDE
添加到光标设置中：
{
"mcp": {
"servers": {
"pattern-library": {
"command": "/path/to/grimoire-mcp/target/release/grimoire-mcp",
"env": {
"PATTERNS_DIR": "/path/to/your/patterns"
}
}
}
}
}
克劳德桌面版
添加 ~/Library/Application Support/Claude/claude_desktop_config.json （macOS）或同等版本：
{
"mcpServers": {
"pattern-library": {
"command": "/path/to/grimoire-mcp/target/release/grimoire-mcp",
"env": {
"PATTERNS_DIR": "/path/to/your/patterns"
}
}
}
}
MCP服务器开发
# Set patterns directory
export PATTERNS_DIR="/home/darko/workspace/kiro-projects/better-agent/pattern-library/patterns"
# Run in debug mode
just debug
# Test with MCP inspector
just mcp-test
