Lexomni MCP
MCP(模型上下文协议)服务器,用于使用SQLite FTS5进行Markdown和PDF索引的本地知识管理。
作者 PagansDev (保罗·加布里埃尔·内维斯·桑托斯)| 存储库:
______________________________________________________________________
英语
用法
作为本地MCP服务器
Lexomni MCP会自动发现 _lexomni 通过从以下位置向上遍历目录树,在项目中创建工作区 cwd如果未找到,则自动创建结构。
- 配置您的MCP客户端(例如Cursor):
"lexomni": {
"command": "npx",
"args": ["-y", "lexomni-mcp"],
"cwd": "/path/to/your/project", # (optional) only if needed
"env": {}
},注: 通常你不需要定义cwd;MCP客户端通常使用当前工作区目录。添加"cwd": "/path/to/your/project"如果需要的话。
注: npx会自动下载并执行该包,您不需要安装任何东西,但在早期版本中,建议克隆存储库并在本地运行,直到我解决问题。 在这种情况下,克隆存储库后,配置将是:
wsl:
"lexomni-local": {
"command": "wsl.exe",
"args": [
"-d", "distro-your.version", # e.g. : Ubuntu-24.04
"--",
"bash", "-lc",
"npx -y /path/to/cloned/repository"
]
}窗户:
"lexomni-local": {
"command": "cmd.exe",
"args": [
"/c",
"npx",
"-y",
"C:\\Users\\User\\Your\\Folders\\lexomni-mcp"
]
}- 添加您的文档:
- _lexomni/user/ -用户标记(指南、架构等) - _lexomni/agent/ -代理人备注(自动生成) - _lexomni/books/ -PDF(书籍、文档等)
文件夹结构(_lexomni/user, _lexomni/agent, _lexomni/books, _lexomni/index)在第一次运行时自动创建。
可用工具
代理自行处理参数
lexomni_listSources
列出工作区中的所有文档(MD和PDF)。
参数: 无
例子:
{
"workspace": "/path/to/project/_lexomni",
"count": 5,
"docs": [...]
}lexomni_buildIndex
将文档索引到SQLite FTS5中,以便快速搜索。
参数:
sources(可选):数组["user", "agent", "books"]
lexomni_searchDocs
跨索引文档的关键字搜索。
参数:
query(必填):字符串,最少2个字符sources(可选):按来源筛选limit(可选):最大结果(1-50,默认10)
例子:
{
"query": "clean architecture",
"hits": [
{
"docId": "user:user/guidelines.md",
"chunkIndex": 0,
"snippet": "...about [clean] [architecture]...",
"source": "user",
"relPath": "user/guidelines.md"
}
]
}lexomni_readDoc
- docId(必填)
- 类型:字符串
目的:索引中文档的唯一标识符。
限制:至少3个字符。 典型来源:取自lexomni_searchDocs返回的点击。
- chunkIndex(可选)
类型:整数 最小值:0 目的:阅读文档的哪个部分。 如果省略:通常默认为第一个块(0),具体取决于实现。
- maxChar(可选)
类型:整数 范围:200-20000 目的:该块返回的最大文本字符数,有助于限制响应大小。
lexomni_writeNote
- 文件名(必填)
类型:字符串 目的:在代理的笔记区域中创建或更新的markdown文件的名称。
限制:至少1个字符。
- 内容(必填)
类型:字符串 目的:标记要写入文件的内容。
限制:至少1个字符。
- 模式(可选)
类型:字符串 允许值: “overwrite”–完全替换现有文件内容。 “append”-将内容附加到现有文件的末尾。 默认值:如果未指定,则“覆盖”。
安全
- 路径遍历被阻止(否
../允许) - 仅限于工作区访问
_lexomni - 写入权限限制为
_lexomni/agent/
建筑
_lexomni/ # In user's project
user/ # Guidelines, architecture (read-only)
agent/ # Agent notes (writable)
books/ # PDFs (read-only)
index/ # SQLite FTS5 (generated)
lexomni.sqlite多语言策略
Lexomni不在内部翻译文本。在PT和EN中查找文档,例如:
- Agent在搜索之前展开查询:
- “分层架构” → 也搜索“分层架构” - 丝(filum的复数)→ 还搜索“消息队列”、“作业队列”
- 生活词汇表
_lexomni/agent/glossary.md:
- 代理通过网络搜索学习新术语 - 随着时间的推移提高搜索质量
发展
npm run build # Build production
npm run dev # Watch mode
npm start # Run built server______________________________________________________________________
许可证
MIT© 保罗·加布里埃尔·内维斯·桑托斯
