diff --git a/README.md b/README.md index eecde8f84c3d9419bd061e79baa043b882367f75..de1cdb2b5597f16508ac52ce50efd304d640a2fd 100644 --- a/README.md +++ b/README.md @@ -43,13 +43,27 @@ calls the `usage` tool is - [internal/server/silverbullet.md](https://git.secluded.site/sb-mcp/blob/main/internal/server/silverbullet.md) - [internal/server/tools.go](https://git.secluded.site/sb-mcp/blob/main/internal/server/tools.go) +This repo also maintains an [Agent Skill] for SilverBullet. If your agent has +CLI access, prefer this over the MCP server because it allows composition +through shell, like piping a page to a file. + +[Agent Skill]: https://agentskills.io/ + +
Click to expand skill installation +Copy/paste this to your agent. + +
+If you already have Agent Skills installed, mkdir "using-silverbullet" next to the other directories, then save "https://git.secluded.site/sb-mcp/blob/main/SKILL.md?raw=1" to "using-silverbullet/SKILL.md". If you do not have any other skills already, STOP and tell me. +
+
+ ## Tools -| Tool | Description | -| -------------- | -------------------------------------------------------------------- | -| `execute_lua` | Run a Space Lua script on the SilverBullet instance. | -| `screenshot` | Capture the current SilverBullet viewport as a PNG image. | -| `console_logs` | Retrieve recent console log entries from SilverBullet for debugging. | +| Tool | Description | +| -------------- | ------------------------------------------------------------------------- | +| `execute_lua` | Run a Space Lua script on the SilverBullet instance. | +| `screenshot` | Capture the current SilverBullet viewport as a PNG image. | +| `console_logs` | Retrieve recent console log entries from SilverBullet for debugging. | | `usage` | Load the full SilverBullet usage guide (Space Lua syntax, APIs, gotchas). | ### `execute_lua` parameters