English | 中文
Rote Toolkit is a TypeScript toolkit for connecting to and extending your Rote note system from terminal workflows and AI agents. It uses the Rote OpenKey API for simple, reusable authentication.
Main project repository: Rabithua/rote.
- CLI mode: quickly create and search notes from terminal.
- MCP mode: run as a Model Context Protocol server so AI tools (Claude/Cursor/VS Code) can safely read and write Rote notes.
- Simple auth: configure OpenKey once and reuse it.
Node.js v18 or higher is required.
npm install -g rote-toolkitRun this command once:
rote configYou will be prompted for:
- Rote API URL: for example
https://your-rote-domain.com - OpenKey: your API key
Credentials are stored at: ~/.rote-toolkit/config.json.
rote add "Today I learned MCP and it is great"Add tags, publish as public, and pin:
rote add "Built a new frontend component" -t "code,frontend,React" --public --pinSearch notes containing MCP:
rote search "MCP"List recent notes (with archive/tag filters):
rote list --limit 5 --archived -t "knowledge"List explore notes (no auth required):
rote explore --limit 5No.
If you configure MCP with npx or bunx, the package is downloaded and run automatically when the MCP server starts.
Global install is only needed when you want to run commands directly on your machine:
npm install -g rote-toolkitrote configThese two commands are equivalent:
rote mcp
rote-mcp{
"mcpServers": {
"rote-toolkit": {
"command": "npx",
"args": ["-y", "-p", "rote-toolkit@latest", "rote-mcp"]
}
}
}{
"servers": {
"rote-toolkit": {
"type": "stdio",
"command": "bunx",
"args": ["-y", "--package", "rote-toolkit@latest", "rote-mcp"]
}
}
}- Track latest:
rote-toolkit@latest - Reproducible setup: pin a version, for example
rote-toolkit@0.3.3
could not determine executable to run: usually incorrectnpxargs, use-p rote-toolkit@... rote-mcp.unknown command 'rote-mcp'(bunx): include--package, for examplebunx -y --package rote-toolkit@latest rote-mcp.
rote_create_noterote_update_noterote_delete_noterote_search_notesrote_list_notesrote_explore_notes
npm install
npm run build
npm run dev -- --helpLogin first:
npm loginBuild + bump version + publish:
npm run release:patchAlso available:
npm run release:minor
npm run release:majorRelease script steps:
- Ensure git workspace is clean
- Check npm login state
npm run buildnpm pack --dry-runnpm version <patch|minor|major>npm publish