文档助手 MCP 服务器
一个用于文档处理、笔记记录和知识管理的模型上下文协议（MCP）服务器。该服务器提供了索引文档、创建笔记、搜索内容和提取元数据的工具。
特点/功能
- 文档索引为快速搜索和检索编制索引文档
- 做笔记创建并使用标签整理Markdown笔记
- 搜索通过关键词和标签搜索已索引的文档
- 元数据提取自动从文档中提取元数据
安装
先决条件
- Python 3.10 或更高版本
- pip（Python包安装工具）
设置
- 克隆或下载此仓库到您的工作区
- 激活你的Python虚拟环境：
source myvenv/bin/activate- 安装依赖项：
pip install -r requirements.txt- 以开发模式安装该包：
pip install -e .项目结构
.
├── .clinerules/ # Cline rules for coding standards
│ ├── 01-coding.md # Core coding standards
│ ├── 02-documentation.md # Documentation requirements
│ └── current-sprint.md # Current sprint rules
├── memory-bank/ # Cline Memory Bank
│ ├── common-knowledge/ # Document format knowledge
│ ├── code-snippets/ # Reusable code patterns
│ └── configuration/ # Configuration settings
├── src/
│ └── document_assistant/ # Main package
│ ├── server.py # MCP server implementation
│ └── utils/ # Utility modules
│ ├── errors.py # Custom exceptions
│ └── document_processor.py # Document processing logic
├── requirements.txt # Python dependencies
├── setup.py # Package setup configuration
└── README.md # This file使用方法
启动服务器
使用Python运行MCP服务器：
python -m document_assistant.server或者使用已安装的控制台脚本：
document-assistant可用工具
1. 索引文档
为文档编制索引以便搜索和检索。
参数：
path（必填）：要索引的文档的路径tags（可选）：用于分类的标签数组
示例：
{
"path": "/path/to/document.md",
"tags": ["work", "project"]
}2. 创建笔记
以Markdown格式创建一个新笔记。
参数：
title（必填）：笔记的标题content（必填）：笔记的Markdown内容tags（可选）：笔记的标签数组
示例：
{
"title": "Meeting Notes",
"content": "## Discussion Points\n\n- Item 1\n- Item 2",
"tags": ["meeting", "2024"]
}3. 搜索文档
通过关键词或标签搜索已索引的文档。
参数：
query（必填）：搜索查询字符串tags（可选）：用于过滤结果的标签数组limit（可选）：最大结果数量（默认：10）
示例：
{
"query": "meeting",
"tags": ["work"],
"limit": 5
}4. 提取元数据
从文档中提取元数据。
参数：
path（必填）：文档路径
示例：
{
"path": "/path/to/document.md"
}配置
存储位置
- 文件：
./documents（自动生成） - 索引：
./index（自动生成） - 备份：
./backups（如果已启用）
支持的文件格式
- Markdown（.md）
- 纯文本（.txt）
- JSON（.json）
发展
运行测试
pytest tests/代码风格
这个项目遵循PEP 8编码规范。请使用以下工具来确保代码质量：
# Format code
black src/
# Check style
flake8 src/
# Type checking
mypy src/MCP配置
要使用此服务器与Cline或其他MCP客户端配合，需将其添加到您的MCP设置中：
{
"mcpServers": {
"document-assistant": {
"command": "python",
"args": ["-m", "document_assistant.server"],
"cwd": "/home/wjmuse/workspace/mcp_daily_life"
}
}
}记忆库
该 memory-bank/ 该目录包含Cline的自定义指令：
- 常识/普遍知识文档格式知识及最佳实践
- 代码片段/可重用的MCP模式和代码示例
- 配置/服务器设置和偏好设置
做出贡献
- 遵循编码标准
.clinerules/01-coding.md - 根据（最新情况）更新文档
.clinerules/02-documentation.md - 查看当前的冲刺规则
.clinerules/current-sprint.md
许可证
麻省理工学院许可证（MIT License）
故障排除
导入错误
如果你遇到导入错误，请确保：
- 虚拟环境已激活
- 依赖项已安装：
pip install -r requirements.txt - 包已以开发模式安装：
pip install -e .
路径问题
- 尽可能使用绝对路径
- 确保文档路径可访问
- 检查文件权限
支持
如遇问题或疑问，请参考：
.clinerules/发展指南目录memory-bank/知识库目录- MCP 文档：https://docs.cline.bot/mcp