forked from new_org/Project-Caffeine
docs(fixed):修改Arabica Sprint1开发指南文档的部分格式
Signed-off-by: gzkoala <guohao@gitconomy.org>
This commit is contained in:
@@ -1,30 +1,33 @@
|
||||
<!--
|
||||
---
|
||||
title: "Project Caffeine Arabica版本 Srpint1开发者指南"
|
||||
description: "Arabica版本第一个迭代版本的开发者指南说明,实现一个最小化的5 Wys提示词策略 MCP Server 功能"
|
||||
type: "Development Guide"
|
||||
file: arabical-sprint1-development-specification-guide.md
|
||||
version: "v1.0.0"
|
||||
author: "Gitconomy Research-郭晧"
|
||||
date: 2026-03-01
|
||||
title: 提示词策略 MCP Server 原型设计文档
|
||||
description: Project Caffeine 提示词策略 MCP Server 的最小可行性功能(MVP)原型设计,涵盖 5 Whys 模板调用、增强提示词合成及 Node.js 环境工作流验证
|
||||
type: Development Guide
|
||||
file: project-caffeine-mvp-sprint1-architecture-design.md
|
||||
version: v1.0.3 (Arabica)
|
||||
author: Gitconomy Research-郭晧
|
||||
date: 2026-03-1
|
||||
last-update: 2026-03-07
|
||||
update-description: 修复部分文本显示格式。
|
||||
tags:
|
||||
- Project Caffeine
|
||||
- MCP
|
||||
- LLM
|
||||
- JSON-RPC 2.0
|
||||
- TypeScript
|
||||
- MCP Server
|
||||
- MVP
|
||||
- Srpint1
|
||||
- Prompt Strategy
|
||||
- 5 Whys
|
||||
- Node.js
|
||||
license: "CC BY-SA 4.0"
|
||||
status: "Active"
|
||||
license: CC BY-SA 4.0
|
||||
status: Active
|
||||
---
|
||||
-->
|
||||
# Arabica Sprint1 版本开发指南说明
|
||||
# Arabica Sprint1 版本开发指南
|
||||
|
||||
## 1. 环境前置要求
|
||||
|
||||
在开始部署前,请确保开发机已安装以下软件:
|
||||
|
||||
- **Node.js**: v18 LTS 或更高版本。
|
||||
- **Node.js**: v20 LTS 或更高版本。
|
||||
- **Visual Studio Code (VS Code)**: 作为主力开发与断点调试 IDE。
|
||||
- **Cherry Studio**: 最新版,作为发起请求的 MCP Client(大模型中枢)。
|
||||
- **本地知识库**: 一个存放 `.md` 格式笔记的本地文件夹(如 Obsidian Vault)。
|
||||
@@ -112,7 +115,7 @@ touch src/app.ts src/services/promptService.ts src/services/resourceService.ts .
|
||||
|
||||
---
|
||||
|
||||
## 4. 第核心业务代码实现
|
||||
## 4. 核心业务代码实现
|
||||
|
||||
### 4.1. `src/services/promptService.ts` (提示词策略生成)
|
||||
|
||||
@@ -145,7 +148,7 @@ export function generate5Whys(query: string): string[] {
|
||||
}
|
||||
```
|
||||
|
||||
### ## 4.2 `src/services/resourceService.ts` (本地知识库访问)
|
||||
### 4.2 `src/services/resourceService.ts` (本地知识库访问)
|
||||
|
||||
带有严格路径防穿越(Path Traversal)安全校验的本地文件读取服务。
|
||||
|
||||
@@ -321,7 +324,7 @@ _(保持这个终端窗口在后台运行不要关闭)_
|
||||
|
||||
1. 进入 Cherry Studio 的 **设置 -> MCP**。
|
||||
|
||||
2. 添加或修改 Server,**关键在于你要指向编译后的 `dist/app.js` 而不是 `src/app.ts`**:
|
||||
2. 添加或修改 Server,关键在于你要指向编译后的 `dist/app.js` 而不是 `src/app.ts`:
|
||||
|
||||
- **Command**: `node`
|
||||
- **Args**: `["--inspect=9229", "/project-caffeine-sprint1/dist/app.js"]`
|
||||
|
||||
Reference in New Issue
Block a user