@ryzome-ai/ryzome-claude-plugin
v1.0.0
Published
Ryzome plugin for Claude Code — canvas and document tools, resources, skills, and agents
Maintainers
Readme
@ryzome-ai/ryzome-claude-plugin
Ryzome plugin for Claude Code. Adds canvas and document tools, library resources, skills, and a context retrieval agent.
Install
In Claude Code:
/install-plugin @ryzome-ai/ryzome-claude-pluginYou'll be prompted for your Ryzome API key (stored securely in your system keychain). Get one at ryzome.ai/api-key.
What's Included
MCP Tools (11)
| Tool | Description |
|------|-------------|
| create_ryzome_document | Create a standalone document in the Ryzome library |
| create_ryzome_canvas | Create a canvas with explicitly defined nodes and edges |
| get_ryzome_document | Retrieve a document by ID with metadata and content details |
| create_ryzome_plan | Create a canvas from sequential steps (auto-chained) |
| create_ryzome_research | Create a canvas with research findings branching from a topic |
| get_ryzome_canvas | Retrieve a canvas by ID with all nodes and edges |
| list_ryzome_documents | List accessible documents, optionally filtered by tag, favorite state, or content type |
| list_ryzome_canvases | List all accessible canvases |
| update_ryzome_document | Update document metadata or content, including appending text |
| save_ryzome_node_to_library | Promote a canvas node's backing document into the library |
| upload_ryzome_image | Upload an image from a URL to an existing canvas |
MCP Resources
| URI | Description |
|-----|-------------|
| ryzome://canvases | JSON list of all canvas summaries |
| ryzome://canvas/{id} | Single canvas rendered as structured markdown |
| ryzome://documents | JSON list of library-visible document summaries |
| ryzome://document/{id} | Single document rendered as structured markdown |
Skills
| Skill | Args | Description |
|-------|------|-------------|
| /plan | goal (required) | Break a goal into steps and create a plan canvas |
| /research | topic (required) | Organize findings on a topic into a research canvas |
| /ryzome-status | — | Check API connection and list recent canvases |
Agent
ryzome-context — A lightweight (Haiku-powered) context retrieval agent that finds and summarizes canvas or document content. It has access to list_ryzome_canvases, get_ryzome_canvas, list_ryzome_documents, and get_ryzome_document.
Hooks
SessionStart — Displays a status message confirming the Ryzome plugin is active and listing available skills.
Configuration
The plugin uses Claude Code's userConfig system:
- On install, you're prompted for
api_key(marked as sensitive, stored in keychain) - Claude Code sets
PLUGIN_USER_CONFIG_API_KEYin the MCP server's environment - The bundled MCP server (
@ryzome-ai/ryzome-mcp) reads it viaRYZOME_API_KEY
userConfig.api_key → PLUGIN_USER_CONFIG_API_KEY env var → ryzome-mcp serverArchitecture
This package ships no code. It is a static configuration bundle:
.claude-plugin/plugin.json # Plugin manifest (name, scopes, userConfig)
.mcp.json # Bundled MCP server config (npx @ryzome-ai/ryzome-mcp)
skills/ # /plan, /research, /ryzome-status
agents/ # ryzome-context retrieval agent for canvases and documents
hooks/ # SessionStart greetingThe actual tool logic lives in @ryzome-ai/ryzome-mcp, which is run via npx when Claude Code starts the MCP server.
License
MIT
