docs: emphasize mcp over cli
This commit is contained in:
1 parent
377b7b9f1d
commit
e1821964d6
2 files changed
+24
-33
No files matched your search
@@ -4,7 +4,7 @@
|
||||
>
|
||||
> **EdgeEver:基于 Cloudflare 全家桶自托管的开源『印象笔记』。**
|
||||
|
||||
EdgeEver 是一个开源、自托管、Cloudflare-native 的现代笔记工作区。它保留经典印象笔记的三栏体验,同时提供清晰的数据模型、REST API、MCP endpoint 和本地 CLI。
|
||||
EdgeEver 是一个开源、自托管、Cloudflare-native 的现代笔记工作区。它保留经典印象笔记的三栏体验,同时提供清晰的数据模型、REST API、OpenAPI schema 和 MCP endpoint。
|
||||
|
||||
<p align="center">
|
||||
<a href="https://deploy.workers.cloudflare.com/?url=https://github.com/msh01/edgeever">
|
||||
@@ -33,7 +33,7 @@ EdgeEver 是一个开源、自托管、Cloudflare-native 的现代笔记工作
|
||||
- PWA 可安装,支持静态应用壳离线打开和自动更新。
|
||||
- 已有笔记支持离线编辑草稿和本地同步队列。
|
||||
- 单用户登录,密码使用 PBKDF2-SHA256 hash。
|
||||
- REST API-first,支持 API Token、OpenAPI、MCP 和 CLI。
|
||||
- REST API-first,支持 API Token、OpenAPI 和 MCP。
|
||||
|
||||
## 技术栈
|
||||
|
||||
@@ -115,38 +115,10 @@ https://你的域名/api/openapi.json
|
||||
|
||||
仓库内文件:[docs/openapi.json](docs/openapi.json)。
|
||||
|
||||
## MCP / CLI
|
||||
## MCP
|
||||
|
||||
先在 EdgeEver 左侧 **设置** 里创建 API Token。给只读 Agent 使用时建议只勾选 `read:notebooks`、`read:memos`、`read:tags`;需要写入、移动、合并或上传附件时再增加对应 `write:*` scope。
|
||||
|
||||
### CLI
|
||||
|
||||
CLI 使用 API Token 访问同一套 REST API。可以直接用环境变量:
|
||||
|
||||
```sh
|
||||
EDGEEVER_URL=https://你的域名 \
|
||||
EDGEEVER_TOKEN=<api-token> \
|
||||
bun run cli -- search edgeever
|
||||
```
|
||||
|
||||
也可以保存为本机 profile,配置文件默认写入 `~/.edgeever/config.json`:
|
||||
|
||||
```sh
|
||||
bun run cli -- profile set prod --url https://你的域名 --token <api-token>
|
||||
bun run cli -- --profile prod notebooks
|
||||
bun run cli -- --profile prod tags
|
||||
bun run cli -- --profile prod search edgeever
|
||||
bun run cli -- --profile prod get <memo-id>
|
||||
bun run cli -- --profile prod create --notebook <notebook-id> --title Hello --body "来自 CLI"
|
||||
bun run cli -- --profile prod update <memo-id> --tags edgeever,cli
|
||||
bun run cli -- --profile prod move --notebook <notebook-id> <memo-id...>
|
||||
bun run cli -- --profile prod merge --notebook <notebook-id> --title "合并笔记" <memo-id...>
|
||||
bun run cli -- --profile prod upload --memo <memo-id> --file ./image.png --type image/png
|
||||
bun run cli -- --profile prod export <memo-id> --format markdown --out ./memo.md
|
||||
```
|
||||
|
||||
### MCP
|
||||
|
||||
MCP endpoint:
|
||||
|
||||
```text
|
||||
@@ -204,3 +176,22 @@ curl https://你的域名/mcp \
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
## 开发者工具
|
||||
|
||||
CLI 不是 EdgeEver 面向 Agent 的主入口,只作为自托管场景下的调试、批处理、备份和迁移工具使用。
|
||||
|
||||
```sh
|
||||
EDGEEVER_URL=https://你的域名 \
|
||||
EDGEEVER_TOKEN=<api-token> \
|
||||
bun run cli -- search edgeever
|
||||
```
|
||||
|
||||
也可以保存为本机 profile,配置文件默认写入 `~/.edgeever/config.json`:
|
||||
|
||||
```sh
|
||||
bun run cli -- profile set prod --url https://你的域名 --token <api-token>
|
||||
bun run cli -- --profile prod notebooks
|
||||
bun run cli -- --profile prod search edgeever
|
||||
bun run cli -- --profile prod export <memo-id> --format markdown --out ./memo.md
|
||||
```
|
||||
@@ -1654,7 +1654,7 @@ const DEFAULT_TOKEN_SCOPES = ["read:notebooks", "read:memos", "read:tags"];
|
||||
|
||||
const SettingsDialog = ({ onClose }: { onClose: () => void }) => {
|
||||
const queryClient = useQueryClient();
|
||||
const [name, setName] = useState("Local Agent");
|
||||
const [name, setName] = useState("MCP Agent");
|
||||
const [selectedScopes, setSelectedScopes] = useState<Set<string>>(() => new Set(DEFAULT_TOKEN_SCOPES));
|
||||
const [createdToken, setCreatedToken] = useState<{ token: string; apiToken: ApiToken } | null>(null);
|
||||
const tokensQuery = useQuery({
|
||||
@@ -1722,7 +1722,7 @@ const SettingsDialog = ({ onClose }: { onClose: () => void }) => {
|
||||
<KeyRound className="h-4 w-4 text-emerald-700" />
|
||||
设置
|
||||
</div>
|
||||
<div className="mt-1 truncate text-xs text-slate-500">API Token / MCP / CLI</div>
|
||||
<div className="mt-1 truncate text-xs text-slate-500">API Token / MCP</div>
|
||||
</div>
|
||||
<Button size="icon" variant="ghost" title="关闭" onClick={onClose}>
|
||||
<X className="h-4 w-4" />
|
||||
|
||||
Reference in new issue
Block a user