@ppdocs/mcp 3.0.7 → 3.0.8

package/dist/tools/index.js

@@ -5,7 +5,7 @@ import { wrap, formatDocMarkdown, formatTreeText, countTreeDocs, formatFileSize
 export function registerTools(server, projectId, _user) {
     // ===================== 跨项目访问 =====================
     // 0. 列出所有可访问的项目
-    server.tool('kg_list_projects', '列出所有可访问的项目(用于跨项目访问)', {}, async () => {
+    server.tool('kg_list_projects', '列出所有可访问的项目(返回name和id)。跨项目操作的第一步：先调用此工具获取项目ID，再作为其他工具的targetProject参数', {}, async () => {
         try {
             const projects = await storage.crossListProjects();
             if (projects.length === 0) {
@@ -197,10 +197,10 @@ export function registerTools(server, projectId, _user) {
         return wrap(doc ? '✅ 项目介绍已更新' : '更新失败');
     });
     // 3.6 获取项目规则
-    server.tool('kg_get_rules', '获取项目规则(可指定类型或获取全部)。支持跨项目只读访问', {
+    server.tool('kg_get_rules', '获取项目规则(可指定类型或获取全部)。支持跨项目只读访问(需先用kg_list_projects获取项目ID)', {
         ruleType: z.string().optional()
             .describe('规则类型(如 userStyles, codeStyle, reviewRules, testRules, unitTests, 或自定义类型)。不传则返回全部'),
-        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目，跨项目只读)')
+        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目)。ID可从kg_list_projects获取')
     }, async (args) => {
         // 跨项目访问
         if (args.targetProject) {
@@ -331,9 +331,9 @@ export function registerTools(server, projectId, _user) {
         }
     });
     // 5. 读取单个文档详情
-    server.tool('kg_read_node', '读取文档完整内容(简介、正文、版本历史、修复记录)。支持跨项目只读访问', {
+    server.tool('kg_read_node', '读取文档完整内容(简介、正文、版本历史、修复记录)。支持跨项目只读访问(需先用kg_list_projects获取项目ID)', {
         nodeId: z.string().describe('文档路径'),
-        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目，跨项目只读)')
+        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目)。ID可从kg_list_projects获取')
     }, async (args) => {
         // 跨项目访问
         if (args.targetProject) {
@@ -354,8 +354,8 @@ export function registerTools(server, projectId, _user) {
         return wrap(lines.join('\n'));
     });
     // 10. 获取知识库树状图
-    server.tool('kg_get_tree', '获取知识库目录树。格式: 📄 文档名 # 简介。支持跨项目只读访问', {
-        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目，跨项目只读)')
+    server.tool('kg_get_tree', '获取知识库目录树。格式: 📄 文档名 # 简介。支持跨项目只读访问(需先用kg_list_projects获取项目ID)', {
+        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目)。ID可从kg_list_projects获取')
     }, async (args) => {
         try {
             // 跨项目访问
@@ -386,9 +386,9 @@ export function registerTools(server, projectId, _user) {
         }
     });
     // 11. 按状态筛选文档
-    server.tool('kg_get_docs_by_status', '获取指定状态的文档列表。支持跨项目只读访问', {
+    server.tool('kg_get_docs_by_status', '获取指定状态的文档列表。支持跨项目只读访问(需先用kg_list_projects获取项目ID)', {
         statusList: z.array(z.string()).describe('状态列表(如["未完成","待修复"])'),
-        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目，跨项目只读)')
+        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目)。ID可从kg_list_projects获取')
     }, async (args) => {
         // 跨项目访问
         if (args.targetProject) {
@@ -518,9 +518,9 @@ export function registerTools(server, projectId, _user) {
         }
     });
     // 列出项目文件
-    server.tool('project_list_files', '列出项目源码目录下的文件。需要先上传文件或项目已关联源码目录。支持跨项目只读访问(用targetProject参考其他项目的文件结构)', {
+    server.tool('project_list_files', '浏览项目源码目录结构(仅列出文件名和大小，不读内容)。目标项目需已上传文件或关联源码目录。跨项目时先用kg_list_projects获取项目ID。查看文件内容请用project_read_file', {
         dir: z.string().optional().describe('子目录路径(如"src/components")，不填则列出根目录'),
-        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目，跨项目只读)')
+        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目)。ID可从kg_list_projects获取')
     }, async (args) => {
         try {
             const files = args.targetProject
@@ -543,9 +543,9 @@ export function registerTools(server, projectId, _user) {
         }
     });
     // 读取项目文件
-    server.tool('project_read_file', '读取项目源码文件内容(文本，限制1MB)。支持跨项目只读访问(用targetProject参考其他项目的代码实现)', {
+    server.tool('project_read_file', '读取单个源码文件的文本内容(限1MB)。适合查看具体代码实现。跨项目时先用kg_list_projects获取项目ID。浏览目录结构请用project_list_files', {
         path: z.string().describe('文件路径(如"src/main.ts")'),
-        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目，跨项目只读)')
+        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目)。ID可从kg_list_projects获取')
     }, async (args) => {
         try {
             const content = args.targetProject
@@ -559,9 +559,9 @@ export function registerTools(server, projectId, _user) {
         }
     });
     // 下载项目目录 (zip → 自动解压)
-    server.tool('project_download_dir', '下载项目源码目录(自动打包zip并解压到本地临时目录)。支持跨项目下载(用targetProject拉取其他项目的模块代码到本地复用)', {
+    server.tool('project_download_dir', '下载整个源码目录到本地临时目录(自动打包zip解压)。适合需要本地复用代码的场景，仅浏览代码请用project_read_file。跨项目时先用kg_list_projects获取项目ID', {
         dir: z.string().describe('目录路径(如"src")'),
-        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目，跨项目只读)')
+        targetProject: z.string().optional().describe('目标项目ID或名称(不填=当前项目)。ID可从kg_list_projects获取')
     }, async (args) => {
         try {
             const result = args.targetProject

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ppdocs/mcp",
-  "version": "3.0.7",
+  "version": "3.0.8",
   "description": "ppdocs MCP Server - Knowledge Graph for Claude",
   "type": "module",
   "main": "dist/index.js",