diff --git a/projects/arabica/docs/test/arabica-sprint2-mcp-inspector-testing-guide.md b/projects/arabica/docs/test/arabica-sprint2-mcp-inspector-testing-guide.md new file mode 100644 index 0000000..8f6c6b0 --- /dev/null +++ b/projects/arabica/docs/test/arabica-sprint2-mcp-inspector-testing-guide.md @@ -0,0 +1,143 @@ + +## 1. 准备工作 + +在启动 Inspector 之前,请确保您的项目已经完成了最新的代码编译。 + +1. 打开终端,进入项目根目录 (`project-caffeine`)。 + +2. 确保所有依赖已安装: + + ``` + npm install + ``` + +3. 编译 TypeScript 代码并复制 JSON 配置文件到 `dist` 目录: + + ``` + npm run build + ``` + +--- + +## 2. 启动 MCP Inspector + +MCP Inspector 作为一个独立的 Node 包运行,它会通过 STDIO (标准输入/输出) 唤起我们的 Server。 + +在项目根目录下,运行以下命令启动 Inspector: + +``` +npx @modelcontextprotocol/inspector node dist/app.js //app.js的绝对地址 +``` + +**启动成功后:** + +终端会输出一个本地链接(例如是 `http://localhost:6274` 或类似地址)。在浏览器中打开该链接,即可进入 MCP Inspector 可视化界面。 + +--- + +## 3. 界面概览与测试流程 + +MCP Inspector 的界面主要分为: + +- **顶栏/侧边栏**:用于在 **Prompts(提示词)**、**Tools(工具)** 和 **Resources(资源)** 之间切换。 + +- **左侧列表**:显示当前 Server 声明的所有可用项。 + +- **右侧面板**:用于输入参数并执行请求,同时展示 Server 返回的原始 JSON 结果。 + + +### 3.1 测试 Prompts (多维思维框架) + +我们在 Sprint 2 中注册了 5 个核心思维框架。 + +**测试步骤:** + +1. 在顶部/侧边菜单中选择 **Prompts**。 + +2. 左侧列表中应该会列出 `scqa`, `5whys`, `5w3h`, `swot`, `pestle`。 + +3. **点击 `scqa`**: + + - 右侧会显示该 Prompt 需要的参数表单。 + + - **situation** (必填): 输入 `一家传统零售企业过去三年线上销售额年均增长仅3%` + + - **context** (可选): 输入 `公司拥有300家实体店网络` + + - **objective** (可选): 输入 `两年内线上销售增速达到15%` + +4. 点击 **Run / Get Prompt** 按钮。 + +5. **验证结果**: + + - 在下方的结果视图中,您应该能看到一条完整的 `messages` 数组。 + + - 检查最后一个 `user` 角色的 `content`,确认您的输入已被正确替换到模板中,并且模板底部包含了我们在 JSON 配置文件中定义的严谨 JSON 输出约束。 + + +### 3.2 测试 Tools (意图拆解与本地文件) + +我们在 Sprint 2 中保留并扩展了工具类方法。 + +**测试步骤:** + +1. 切换到 **Tools** 面板。 + +2. 左侧列表应显示 `generate_search_queries`, `list_local_notes`, `read_local_note`, `save_note`。 + +3. **测试意图拆解 (`generate_search_queries`)**: + + - 在右侧的 `query` 参数框中输入:`新能源汽车电池回收技术难点` + + - 点击执行。 + + - **验证结果**:检查输出的 `content` 数组,应该返回一段包含 3-5 个专业检索词的 JSON 字符串。 + +4. **测试文件读取 (`read_local_note`)**(可选,需确保本地知识库路径配置正确): + + - 输入 `filename` 为 `test.md`(假设您的 Vault 中有此文件)。 + + - 点击执行并查看返回的 Markdown 文本内容。 + + +### 3.3 测试 Resources (本地知识库注入) + +通过 Resources,客户端可以直接浏览并挂载本地文件作为大模型上下文。 + +**测试步骤:** + +1. 切换到 **Resources** 面板。 + +2. **列表测试**: + + - Inspector 启动时会自动调用 `resources/list`。左侧应该会展示您在 `OBSIDIAN_VAULT_PATH` 目录下所有的 `.md` 文件列表。 + +3. **读取测试**: + + - 点击列表中的任意一个笔记(URI 类似 `note://local/xxx.md`)。 + + - **验证结果**:右侧的 Content 区域应正确渲染或展示该 Markdown 文件的文本内容。 + +---- + +## 许可声明 + +本文档采用 **知识共享署名--相同方式共享 4.0 国际许可协议 (CC BY--SA 4.0)** 进行许可,© 2025-2026 Gitconomy Research.