journal-mcp

🚀 日志MCP服务器

日志MCP服务器是一款支持日志条目管理的Model Context Protocol (MCP) 服务器，搭配 React Router v7 网络查看器，可提供便捷的日志浏览体验。

✨ 主要特性

• 📖 MCP服务器：与Claude Desktop集成，实现日志管理功能。
• 🌐 网络查看器：基于React的界面，方便浏览日志条目。
• 🚀 服务器端渲染：借助React Router实现服务器端渲染。
• ⚡️ 热模块替换（HMR）：开发过程中支持热模块替换，提升开发效率。
• 🔒 默认使用TypeScript：保证代码的类型安全。
• 🎉 TailwindCSS样式：采用TailwindCSS进行样式设计。
• 📁 基于文件的存储：自动组织日志文件，方便管理。

🚀 快速开始

使用npx快速启动

无需安装，直接运行：

# 启动网络查看器
npx @coji/journal-mcp --viewer

# 设置Claude Desktop集成
npx @coji/journal-mcp --setup

# 为Claude Desktop启动MCP服务器
npx @coji/journal-mcp

本地开发

安装依赖：

pnpm install

开发模式

启动带有热模块替换的开发服务器：

pnpm dev

网络查看器将在 http://localhost:5173 可用。

生产环境构建

创建生产环境构建：

pnpm build

💻 使用示例

使用npx（推荐）

# 显示帮助信息
npx @coji/journal-mcp --help

# 设置Claude Desktop集成
npx @coji/journal-mcp --setup

# 验证Claude Desktop设置
npx @coji/journal-mcp --verify-setup

# 为Claude Desktop启动MCP服务器
npx @coji/journal-mcp

# 启动网络查看器
npx @coji/journal-mcp --viewer

# 自定义端口示例
npx @coji/journal-mcp --viewer --port 8080

本地开发命令

本地安装后进行开发：

# 显示帮助信息
node dist/index.js --help

# 设置Claude Desktop配置
node dist/index.js --setup

# 启动MCP服务器
node dist/index.js

# 启动网络查看器
node dist/index.js --viewer

网络查看器将在 http://localhost:8765（或你指定的端口）可用。

📚 详细文档

MCP工具

服务器为Claude Desktop提供以下工具：

1. add_entry - 添加新的日志条目
2. search_entries - 按日期范围、标签或关键词搜索
3. get_recent_entries - 获取最近的日志条目
4. list_tags - 列出所有标签及其使用次数
5. get_entry_by_date - 获取特定日期的日志条目
6. get_daily_summary - 获取日志统计信息

文件存储

日志条目存储在以下位置：

• 位置：~/.local/share/journal-mcp/entries/YYYY/MM/YYYY-MM-DD.md
• 格式：带有YAML前置元数据的Markdown格式
• 特性：自动提取标签，按时间组织文件

🚀 部署

Docker部署

docker build -t journal-mcp .
docker run -p 8765:8765 journal-mcp

手动部署

部署 pnpm build 的输出：

├── package.json
├── pnpm-lock.yaml
├── build/
│   ├── client/    # 静态资源
│   └── server/    # 服务器端代码

本项目使用 React Router 和 MCP 精心打造 ❤️。