使用说明
本地开发MCP服务器
用于Claude Desktop的本地MCP服务器,具有持久任务管理、文件操作、文档生成和PDF索引功能。
v2.0.0的新增功能
- SQLite任务持久化 --任务现在可以在服务器重启和重新编译后继续执行
- 零本地依赖 --用途
sql.js(SQLite作为WebAssembly),安装在Windows/macOS/Linux上,无需构建工具 - 两个新的任务工具 —
delete-task和search-tasks - 每周回顾工具 —
tasks-completed-this-week用于站立
先决条件
- Node.js 18+
- npm
- 克劳德桌面版
快速开始
1.克隆并安装
git clone <your-repo-url>
cd mcp-server
npm install
无需构建工具-- sql.js 是纯WebAssembly。
2.构建和运行
npm run build
npm start
预期产量:
Task database created at: C:\Users\<you>\mcp-tasks.db
MCP Server v2.0.0 running on stdio
Task database: C:\Users\<you>\mcp-tasks.db
3.连接克劳德桌面
编辑您的Claude配置:
- 窗户:
%APPDATA%\Claude\claude_desktop_config.json - macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
{
"mcpServers": {
"local-dev": {
"command": "node",
"args": ["C:\\Projects\\mcp-server\\dist\\index.js"]
}
}
}
保存后重新启动Claude Desktop。
开发工作流程
本地开发(自动重启)
npm run watch
Claude桌面工作流程
npm run build
# restart Claude Desktop
任务数据库
任务存储在SQLite数据库中:
- 窗户:
C:\Users\<you>\mcp-tasks.db - macOS/Linux:
~/mcp-tasks.db
数据库在首次运行时自动创建。服务器在启动时将其加载到内存中,并在每次写入后将其保存到磁盘。您可以使用任何SQLite查看器打开它(例如。 SQLite数据库浏览器).
如何使用任务工具
连接后在Claude Desktop中尝试以下提示:
| 你想要什么 | 该对克劳德说什么 |
|---|---|
| 添加任务 | “创建任务:查看API文档,高优先级” |
| 查看所有任务 | “列出我的所有任务” |
| 按状态筛选 | “显示所有正在进行的任务” |
| 向前移动任务 | “将任务1标记为已完成” |
| 查找任务 | “在任务中搜索‘身份验证’” |
| 每周回顾 | “我本周完成了哪些任务?” |
| 清理 | “删除任务-3” |
可用工具
文件操作
| 工具 | 说明 |
|---|---|
read-file |
从磁盘读取任何文件 |
write-file |
写入/创建文件 |
list-directory |
列出文件夹内容 |
任务管理(SQLite——持久化)
| 工具 | 说明 |
|---|---|
create-task |
创建任务(立即保存到数据库) |
list-tasks |
列出任务,可按状态筛选 |
update-task-status |
将任务移至待办/进行中/已完成 |
delete-task |
永久删除任务 |
search-tasks |
按关键字搜索任务 |
tasks-completed-this-week |
显示过去7天内完成的任务 |
文档生成
| 工具 | 说明 |
|---|---|
generate-markdown-doc |
生成结构化 .md 文件 |
generate-readme |
脚手架a README.md 模板 |
PDF/文档索引
| 工具 | 说明 |
|---|---|
read-pdf |
从PDF中提取文本 |
index-documents |
在文件夹中批量索引PDF |
search-documents |
跨索引PDF的关键字搜索 |
list-indexes |
显示所有活动索引 |
可用脚本
npm run build # Compile TypeScript to dist/
npm run dev # Run from source once (tsx)
npm start # Run compiled server (dist/index.js)
npm run watch # Run from source with auto-restart
文档
- QUICKSTART.md --设置和首次运行
- TUTORIAL.md --添加您自己的工具
- 故障排除.md --常见修复
- API_REFERENCE.md --技术参考
- 文件.md --体系结构概述
