@heptabase/mcp
用于与 Heptabase 备份数据交互的模型上下文协议 (MCP) 服务。该服务允许像 Claude 这样的 AI 助手搜索、检索、分析和导出 Heptabase 白板和卡片。
特征
- 🔍 搜索白板和卡片
- 📁 自动备份文件管理
- 📄 导出为多种格式(Markdown、JSON、Mermaid)
- 🔗 分析卡片关系
- 📊 生成白板摘要
- ⚡ 智能缓存以提高性能
快速入门
与 Claude Desktop 一起使用(推荐)
使用此 MCP 服务的最简单方法是通过npx
使用 Claude Desktop:
{
"mcpServers": {
"heptabase": {
"command": "npx",
"args": ["@heptabase/mcp"],
"env": {
"HEPTABASE_BACKUP_PATH": "/path/to/your/heptabase/backups",
"HEPTABASE_AUTO_EXTRACT": "true",
"HEPTABASE_WATCH_DIRECTORY": "true"
}
}
}
}
有关详细的设置说明,请参阅CLAUDE_DESKTOP_NPX.md
。
本地开发
- 安装依赖项:
- 使用环境变量进行配置。创建一个
.env
文件:HEPTABASE_BACKUP_PATH=/path/to/your/heptabase/backups
HEPTABASE_AUTO_EXTRACT=true
HEPTABASE_WATCH_DIRECTORY=true
- 启动 MCP 服务器:
基本用法
// Configure backup path
await mcpClient.callTool({
name: "configureBackupPath",
parameters: {
path: "/Users/stanley/Documents/Heptabase-auto-backup"
}
});
// List available backups
const { backups } = await mcpClient.callTool({
name: "listBackups"
});
// Search for whiteboards
const { whiteboards } = await mcpClient.callTool({
name: "searchWhiteboards",
parameters: {
query: "Project Planning"
}
});
可用工具
备份管理
configureBackupPath
- 设置备份目录listBackups
列出可用的备份loadBackup
- 加载特定备份
搜索行动
searchWhiteboards
- 搜索白板searchCards
- 搜索卡片
数据检索
getWhiteboard
- 获取白板数据getCard
- 获取卡数据getCardsByArea
- 根据位置获取卡片
导出函数
exportWhiteboard
导出为各种格式summarizeWhiteboard
- 生成摘要
分析工具
analyzeGraph
- 分析关系compareBackups
- 比较版本
发展
项目结构
heptabase-mcp/
├── src/
│ ├── index.ts # MCP server
│ ├── config/ # Configuration
│ ├── services/ # Core services
│ ├── tools/ # MCP tools
│ └── types/ # TypeScript types
├── tests/ # Test files
├── package.json
└── tsconfig.json
测试
建筑
文档
有关详细文档,请参阅SPECIFICATION.md 。
执照
麻省理工学院
贡献
欢迎贡献!提交 PR 之前,请阅读我们的贡献指南。
支持
对于问题和功能请求,请使用 GitHub 问题跟踪器。