From e1821964d6851bb109d16cd848cfcf00cd974d42 Mon Sep 17 00:00:00 2001 From: tianma Date: Sat, 27 Jun 2026 01:54:18 +0800 Subject: [PATCH] docs: emphasize mcp over cli --- README.md | 53 +++++++++++++++++----------------------- apps/web/src/app/App.tsx | 4 +-- 2 files changed, 24 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 3b94ad96..46f8df91 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ > > **EdgeEver:基于 Cloudflare 全家桶自托管的开源『印象笔记』。** -EdgeEver 是一个开源、自托管、Cloudflare-native 的现代笔记工作区。它保留经典印象笔记的三栏体验,同时提供清晰的数据模型、REST API、MCP endpoint 和本地 CLI。 +EdgeEver 是一个开源、自托管、Cloudflare-native 的现代笔记工作区。它保留经典印象笔记的三栏体验,同时提供清晰的数据模型、REST API、OpenAPI schema 和 MCP endpoint。

@@ -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= \ -bun run cli -- search edgeever -``` - -也可以保存为本机 profile,配置文件默认写入 `~/.edgeever/config.json`: - -```sh -bun run cli -- profile set prod --url https://你的域名 --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 -bun run cli -- --profile prod create --notebook --title Hello --body "来自 CLI" -bun run cli -- --profile prod update --tags edgeever,cli -bun run cli -- --profile prod move --notebook -bun run cli -- --profile prod merge --notebook --title "合并笔记" -bun run cli -- --profile prod upload --memo --file ./image.png --type image/png -bun run cli -- --profile prod export --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= \ +bun run cli -- search edgeever +``` + +也可以保存为本机 profile,配置文件默认写入 `~/.edgeever/config.json`: + +```sh +bun run cli -- profile set prod --url https://你的域名 --token +bun run cli -- --profile prod notebooks +bun run cli -- --profile prod search edgeever +bun run cli -- --profile prod export --format markdown --out ./memo.md +``` diff --git a/apps/web/src/app/App.tsx b/apps/web/src/app/App.tsx index 376aff1a..7e01cf84 100644 --- a/apps/web/src/app/App.tsx +++ b/apps/web/src/app/App.tsx @@ -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>(() => 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 }) => { 设置 -

API Token / MCP / CLI
+
API Token / MCP