rote-toolkit 0.2.1 → 0.3.1

package/README.md

@@ -21,10 +21,11 @@ npm install -g rote-toolkit
 运行以下命令进行全局配置：
 
 ```bash
-rote login
+rote config
 ```
 
 系统会提示你输入：
+
 1. **Rote API URL**：例如 `https://your-rote-domain.com`
 2. **OpenKey**：你的 API 密钥
 
@@ -38,18 +39,26 @@ rote login
 rote add "今天学到了 MCP 协议，非常有趣！"
 ```
 
-附带标签：
+附带标签、设为公开并置顶：
 
 ```bash
-rote add "实现了一个新的前端组件" -t "代码,前端,React"
+rote add "实现了一个新的前端组件" -t "代码,前端,React" --public --pin
 ```
 
-### 2) 搜索笔记
+### 2) 搜索和获取笔记
+
+搜索包含 "MCP" 的笔记：
 
 ```bash
 rote search "MCP"
 ```
 
+获取最近的笔记（支持过滤归档和标签）：
+
+```bash
+rote list --limit 5 --archived -t "知识管理"
+```
+
 ## MCP 模式使用指南
 
 启动 MCP Server：
@@ -71,11 +80,7 @@ rote-mcp
   "mcpServers": {
     "rote-toolkit": {
       "command": "npx",
-      "args": [
-        "-y",
-        "rote-toolkit",
-        "mcp"
-      ]
+      "args": ["-y", "rote-toolkit", "mcp"]
     }
   }
 }
@@ -88,7 +93,9 @@ rote-mcp
 - `rote_list_notes`
 
 ## 本地开发
+
 [text](../../../Downloads/API-KEY-GUIDE.md)
+
 ```bash
 npm install
 npm run build
@@ -117,6 +124,7 @@ npm run release:major
 ```
 
 发布脚本会执行：
+
 1. 检查 git 工作区是否干净
 2. 检查 npm 登录状态
 3. `npm run build`

package/dist/api.js

@@ -16,8 +16,7 @@ export class RoteClient {
             content: input.content,
             title: input.title ?? "",
             tags: input.tags ?? [],
-            state: input.state ?? "private",
-            type: input.type ?? "rote",
+            state: input.isPublic ? "public" : "private",
             pin: input.pin ?? false,
             ...(input.articleId ? { articleId: input.articleId } : {}),
         };
@@ -37,6 +36,12 @@ export class RoteClient {
             limit: String(input.limit ?? 10),
             skip: String(input.skip ?? 0),
         });
+        if (input.archived !== undefined) {
+            params.set("archived", String(input.archived));
+        }
+        if (input.tag) {
+            input.tag.forEach((t) => params.append("tag", t));
+        }
         return this.request(`/v2/api/openkey/notes/search?${params.toString()}`);
     }
     async listNotes(input = {}) {
@@ -45,6 +50,12 @@ export class RoteClient {
             limit: String(input.limit ?? 10),
             skip: String(input.skip ?? 0),
         });
+        if (input.archived !== undefined) {
+            params.set("archived", String(input.archived));
+        }
+        if (input.tag) {
+            input.tag.forEach((t) => params.append("tag", t));
+        }
         return this.request(`/v2/api/openkey/notes?${params.toString()}`);
     }
     async createArticle(input) {

package/dist/cli.js

@@ -9,7 +9,8 @@ import { startMcpServer } from "./mcp.js";
 const program = new Command();
 program.name("rote").description("Rote Toolkit CLI").version("0.1.0");
 program
-    .command("login")
+    .command("config")
+    .alias("login")
     .description("Configure Rote API URL and OpenKey")
     .action(async () => {
     const rl = createInterface({ input, output });
@@ -29,7 +30,8 @@ program
     .argument("<content>", "note content")
     .option("-t, --tags <tags>", "comma-separated tags")
     .option("--title <title>", "title")
-    .option("--state <state>", "note state", "private")
+    .option("--public", "publish as public note")
+    .option("--pin", "pin the note")
     .option("--article-id <articleId>", "bind to an existing article")
     .action(async (content, options) => {
     const client = new RoteClient();
@@ -38,7 +40,8 @@ program
         content,
         tags,
         title: options.title,
-        state: options.state,
+        isPublic: options.public,
+        pin: options.pin,
         articleId: options.articleId,
     });
     console.log(`Created note: ${note.id}`);
@@ -84,6 +87,8 @@ program
     .argument("<action>", "action to perform (get|update)")
     .option("--nickname <nickname>", "new nickname")
     .option("--description <description>", "new description")
+    .option("--avatar <url>", "new avatar URL")
+    .option("--cover <url>", "new cover URL")
     .option("--username <username>", "new username")
     .action(async (action, options) => {
     const client = new RoteClient();
@@ -95,6 +100,8 @@ program
         const profile = await client.updateProfile({
             nickname: options.nickname,
             description: options.description,
+            avatar: options.avatar,
+            cover: options.cover,
             username: options.username,
         });
         console.log(`Updated profile for: ${profile.username}`);
@@ -117,12 +124,35 @@ program
     .argument("<keyword>", "search keyword")
     .option("-l, --limit <limit>", "max results", parseInt, 10)
     .option("-s, --skip <skip>", "offset", parseInt, 0)
+    .option("--archived", "include archived notes")
+    .option("-t, --tag <tags>", "comma-separated tags to filter by")
     .action(async (keyword, options) => {
     const client = new RoteClient();
+    const tag = parseTags(options.tag);
     const notes = await client.searchNotes({
         keyword,
         limit: options.limit,
         skip: options.skip,
+        archived: options.archived,
+        tag: tag.length > 0 ? tag : undefined,
+    });
+    printNotes(notes);
+});
+program
+    .command("list")
+    .description("List recent notes")
+    .option("-l, --limit <limit>", "max results", parseInt, 10)
+    .option("-s, --skip <skip>", "offset", parseInt, 0)
+    .option("--archived", "include archived notes")
+    .option("-t, --tag <tags>", "comma-separated tags to filter by")
+    .action(async (options) => {
+    const client = new RoteClient();
+    const tag = parseTags(options.tag);
+    const notes = await client.listNotes({
+        limit: options.limit,
+        skip: options.skip,
+        archived: options.archived,
+        tag: tag.length > 0 ? tag : undefined,
     });
     printNotes(notes);
 });

package/dist/config.js

@@ -19,12 +19,12 @@ export function saveConfig(config) {
 }
 export function loadConfig() {
     if (!existsSync(CONFIG_PATH)) {
-        throw new Error(`Config not found at ${CONFIG_PATH}. Run "rote login" first.`);
+        throw new Error(`Config not found at ${CONFIG_PATH}. Run "rote config" first.`);
     }
     const raw = readFileSync(CONFIG_PATH, 'utf8');
     const parsed = JSON.parse(raw);
     if (!parsed.apiUrl || !parsed.openKey) {
-        throw new Error(`Invalid config at ${CONFIG_PATH}. Run "rote login" again.`);
+        throw new Error(`Invalid config at ${CONFIG_PATH}. Run "rote config" again.`);
     }
     return {
         apiUrl: normalizeApiUrl(parsed.apiUrl),

package/dist/mcp.js

@@ -15,18 +15,20 @@ export async function startMcpServer() {
             content: z.string().min(1).describe("Note content"),
             title: z.string().optional().describe("Optional note title"),
             tags: z.array(z.string()).optional().describe("Optional list of tags"),
-            state: z.string().optional().describe("Note state, default private"),
+            isPublic: z.boolean().optional().describe("Publish as public note"),
+            pin: z.boolean().optional().describe("Whether to pin the note"),
             articleId: z
                 .string()
                 .optional()
                 .describe("Optional article ID to bind to"),
         },
-    }, async ({ content, title, tags, state, articleId }) => {
+    }, async ({ content, title, tags, isPublic, pin, articleId }) => {
         const note = await client.createNote({
             content,
             title,
             tags,
-            state,
+            isPublic,
+            pin,
             articleId,
         });
         return {
@@ -163,9 +165,17 @@ export async function startMcpServer() {
                 .min(0)
                 .optional()
                 .describe("Pagination offset, default 0"),
+            archived: z.boolean().optional().describe("Include archived notes"),
+            tag: z.array(z.string()).optional().describe("Tag filter"),
         },
-    }, async ({ keyword, limit, skip }) => {
-        const notes = await client.searchNotes({ keyword, limit, skip });
+    }, async ({ keyword, limit, skip, archived, tag }) => {
+        const notes = await client.searchNotes({
+            keyword,
+            limit,
+            skip,
+            archived,
+            tag,
+        });
         const lines = notes.map((note, i) => `${i + 1}. ${truncateSingleLine(note.content, 100)}`);
         return {
             content: [
@@ -192,9 +202,11 @@ export async function startMcpServer() {
                 .min(0)
                 .optional()
                 .describe("Pagination offset, default 0"),
+            archived: z.boolean().optional().describe("Include archived notes"),
+            tag: z.array(z.string()).optional().describe("Tag filter"),
         },
-    }, async ({ limit, skip }) => {
-        const notes = await client.listNotes({ limit, skip });
+    }, async ({ limit, skip, archived, tag }) => {
+        const notes = await client.listNotes({ limit, skip, archived, tag });
         const lines = notes.map((note, i) => `${i + 1}. ${truncateSingleLine(note.content, 100)}`);
         return {
             content: [

package/dist/types.d.ts

@@ -8,7 +8,6 @@ export interface RoteNote {
     title?: string;
     tags?: string[];
     state?: string;
-    type?: string;
     createdAt?: string;
     updatedAt?: string;
 }
@@ -21,8 +20,7 @@ export interface CreateNoteInput {
     content: string;
     title?: string;
     tags?: string[];
-    state?: string;
-    type?: string;
+    isPublic?: boolean;
     pin?: boolean;
     articleId?: string;
 }
@@ -83,8 +81,12 @@ export interface SearchNotesInput {
     keyword: string;
     limit?: number;
     skip?: number;
+    archived?: boolean;
+    tag?: string[];
 }
 export interface ListNotesInput {
     limit?: number;
     skip?: number;
+    archived?: boolean;
+    tag?: string[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rote-toolkit",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "CLI and MCP toolkit for Rote OpenKey API",
   "type": "module",
   "main": "dist/index.js",