用途
LLM Wiki 是一个在用户本机运行的桌面应用。本技能用于操作该应用及其项目文件,当用户明确提到 LLM Wiki、我的 wiki、知识库、某个 Wiki 页面或项目时适用。它围绕本地知识库的检索、Agent 对话、评审维护与文件更新展开。
主要能力
- 通过桌面应用的 localhost API 或 MCP 进行检索与 Agent 操作。
- 支持读取、搜索、评审(reviews)、聊天(chat)、图谱(graph)与重扫描(rescan)等操作。
- 通过 GET /health 探测服务健康状态,0.6.4 版本会报告 API、MCP 与 Agent 状态,包括 agent.chat。
- 通过 POST /projects/{id}/search 进行检索,通常使用 topK 5 到 10。
- 通过 GET /projects/{id}/files/content?path=... 读取文件内容,或使用 includeContent: true。
- 通过 GET /projects/{id}/reviews 列出未解决或经过筛选的评审条目。
- 通过 POST /projects/{id}/chat 调用后端 Wiki Agent,可返回引用、工具事件、会话状态与用量。
- 通过 POST /projects/{id}/chat/{sessionId}/cancel 取消活跃的 Agent 会话。
- 在获得授权时,对明确选定的项目进行 Markdown 文件维护。
使用方式
选择传输方式
- 若 LLM Wiki MCP 工具可调用,优先使用 MCP 进行受支持的读取、搜索、评审、聊天、图谱与重扫描。
- 若 HTTP API 已启用并通过认证,则调用 http://127.0.0.1:19828/api/v1,使用 JSON。
- 若 API 认证不可用且目标是固定的 jay-llm-wiki 项目,可回退到本地 rg 与文件读取;仅在调用工作流授权时才允许写入。
- 若其他项目需要受保护的 API 访问,请让用户配置 token 或启用 MCP 服务器。
在使用评审、聊天、取消功能或处理 API 错误前,先阅读 references/api-reference.md;需要命令语法时阅读 references/examples.md。
无密钥探测健康状态
- 在执行受保护 API 操作前,始终先调用 GET /health。
- 使用 LLM_WIKI_API_TOKEN 或桌面应用存储的 token。
- 优先使用 Authorization: Bearer <token>。
- 绝不回显、记录、粘贴 token,也不要把 token 放进 URL。
- 若 authConfigured 为 false 且未认证访问被禁用,在适用时使用固定项目的文件系统回退,不要因此阻塞基于文件的知识处理。
解析项目
- 当用户明确指桌面应用中打开的项目时,使用 current。
- 提供 UUID 时使用 UUID。
- 工作流固定项目路径时,使用 URL 编码的绝对路径。
- 项目名称需通过 GET /projects 解析,不要把名称作为 {id} 传入。
- 为当前任务缓存已解析的项目,若用户切换项目则重新解析。
检索有依据的知识
- 使用 POST /projects/{id}/search 搜索,通常取 topK 5 到 10。
- 用 GET /projects/{id}/files/content?path=... 读取有前景的文件,或使用 includeContent: true。
- 相对排名、检索模式和页面内容应作为上下文,而非最终证据。
- 引用每一个实质性支撑答案的 Wiki 路径。
- 对于来自 $search-jay-llm-wiki 的强制背景检查,优先使用本地关键词搜索或 /search。默认不要把完整用户提示发送到 /chat。
使用 0.6.4 的 Agent 与评审能力
- 用 GET /projects/{id}/reviews 列出未解决或经过筛选的评审条目。
- 用 POST /projects/{id}/chat 向后端 Wiki Agent 提问,它可返回引用、工具事件、会话状态与用量。
- 用 POST /projects/{id}/chat/{sessionId}/cancel 取消活跃的 Agent 会话。
- 仅当用户请求与数据边界允许时,才启用后端 web 或 AnyTXT 工具。
- 若 /health 报告 agent.streaming 为 false,不要声称支持流式输出。
维护文件(不臆造 API)
LLM Wiki API v1 没有创建或更新 Wiki Markdown 的接口。直接编辑文件系统是获得授权项目的写入路径。POST /sources/rescan 仅重扫描已配置的源文件夹并把变更的源工作加入队列,它不是通用的 Wiki 写入接口。
编辑固定个人 Wiki 时:
- 解析 JAY_LLM_WIKI_ROOT,默认 E:\Code\Personal\jay-llm-wiki。
- 读取其 AGENTS.md、purpose.md 与 schema.md。
- 编辑前检查 Git 状态与目标差异。
- 保留无关工作与现有原始来源。
- 在磁盘上校验并引用变更路径。
适用场景
- 用户明确提及 LLM Wiki、我的 wiki、知识库,或某个 Wiki 页面/项目。
- 需要在本地知识库中检索、引用有依据的内容。
- 需要调用后端 Wiki Agent 进行问答或评审管理。
- 需要在授权范围内维护固定项目的 Markdown 文件。
限制
- LLM Wiki API v1 没有创建或更新 Wiki Markdown 的接口,写入依赖直接文件系统编辑。
- POST /sources/rescan 仅重扫描配置的源文件夹,不是通用写入接口。
- 不流式输出(当 /health 报告 agent.streaming: false 时)。
- 其他项目需受保护 API 访问时,需用户配置 token 或启用 MCP。
- 相对排名、检索模式与页面内容仅是上下文,不构成最终证据。
失败处理
- 连接失败:告知用户桌面应用不可达,随后在可能时使用固定项目回退。
- 401:token 缺失或错误,不要循环重试。
- 403:路径超出允许的 API 范围,不要对同一路径重试。
- 404:重新解析项目或路由。
- 413/415:缩小请求范围或使用允许的文本来源。
- 429/busy 503:退避并降低并发。
- 其他 5xx:报告错误并停止重试。