obelisk-mcp 0.1.4 → 0.2.0

package/README.md

@@ -12,10 +12,18 @@ rename.
 
 ## Status
 
-Pre-release. Anchoring, decoration, the sidebar, suggested edits and the agent
-integration are implemented. The CLI and the MCP server are on npm as
-`obelisk-mcp`; the plugin has not been submitted to the community plugin list,
-and none of it has been exercised against a large vault.
+Early. Anchoring, decoration, the sidebar, suggested edits and the agent
+integration are implemented. The plugin is in the Obsidian community plugin
+directory, and the CLI and the MCP server are on npm as `obelisk-mcp`. None of
+it has been exercised against a large vault.
+
+## Install
+
+Search for **Obelisk** in *Settings → Community plugins → Browse*, install it,
+and enable it. Updates come from the same panel.
+
+The plugin can also be added via the *Add to Obsidian* button in its
+[directory listing](https://community.obsidian.md/plugins/obelisk).
 
 ## Features
 
@@ -32,7 +40,7 @@ and none of it has been exercised against a large vault.
 - **Sidebar.** All of a note's comments in document order, or newest first from
   the sort toggle. Click one to scroll the editor to it. Chips filter to open
   comments, to comments carrying a suggestion, or to one agent's review pass.
-  Resolved comments stay in the list, greyed rather than hidden, since they are
+  Resolved comments stay in the list, grayed rather than hidden, since they are
   still highlighted in the note.
 - **In-text highlighting.** Commented passages are highlighted, with a †
   marker that opens the comment in the sidebar.
@@ -58,9 +66,9 @@ and none of it has been exercised against a large vault.
   from the trash icon in its header, so striking one remark out of a thread
   does not take the conversation with it. Both offer an undo rather than a
   confirmation dialog.
-- **Open to agents.** A command-line tool and an MCP server can read and write
-  the same comments from outside Obsidian, so a model can review a note into
-  your sidebar, or answer the comments you left for it. Its comments are
+- **Open to agents.** A command-line tool and an MCP server read and write the
+  same comments from outside Obsidian, so a model can review a note into the
+  sidebar, or answer the comments left for it. Its comments are
   badged, and a whole review pass is one chip in the header with a *dismiss
   all* on it. See below.
 
@@ -125,12 +133,12 @@ agent is running in, and an absolute path reaches a note in one it is not. The
 server is listed in the official MCP registry as `io.github.zachhannum/obelisk`
 for a client that installs from there.
 
-**There is nothing to start.** It speaks MCP over stdio: the agent spawns a
-process when a session opens and kills it when the session ends, so
-`obelisk-mcp` is never run by hand and there is no port and no daemon. One
-process per session is also what makes a session's comments share one run chip
-in the sidebar. A session keeps the process it spawned, so a new version of the
-package arrives at the next one. To take it sooner, reconnect from `/mcp`.
+**The agent starts it.** It speaks MCP over stdio: the agent spawns a process
+when a session opens and kills it when the session ends, so there is no port
+and no daemon. One process per session is also what makes a session's comments
+share one run chip in the sidebar. A session keeps the process it spawned, so a
+new version of the package arrives at the next one. To take it sooner,
+reconnect from `/mcp`.
 
 To check the registration, `claude mcp list`, or `/mcp` inside a session. To
 check the server itself with no agent in the way:
@@ -143,22 +151,21 @@ printf '%s\n' \
   | npx -y obelisk-mcp
 ```
 
-That should print the handshake and then the four tools. A server that fails
-this fails the same way for an agent, which is worth knowing before you go
-looking at the agent's end of it.
+That prints the handshake and then the four tools. A server that fails this
+fails the same way for an agent.
 
 For an agent that does not speak MCP, paste
 [`docs/agents-fragment.md`](docs/agents-fragment.md) into the vault's
 `AGENTS.md` or `CLAUDE.md`.
 
 The one rule worth knowing: **the quote is the anchor.** A line number is never
-one. A model asked for a line will produce a plausible wrong number, and a
-plausible wrong number attaches a comment to the wrong paragraph without ever
-looking like an error, so `--near-line` only picks between identical quotes and
-takes a number copied out of `obelisk list`. `--quote` has to appear in the
-note character for character, and if it does not, or appears twice, nothing is
-written and the reason is printed. `obelisk list` prints the body numbered so
-the exact text is there to copy.
+one. A model asked for a line produces a plausible wrong number, which attaches
+a comment to the wrong paragraph without looking like an error, so
+`--near-line` only picks between identical quotes and takes a number copied out
+of `obelisk list`. `--quote` has to appear in the note character for character,
+and if it does not, or appears twice, nothing is written and the reason is
+printed. `obelisk list` prints the body numbered so the exact text is there to
+copy.
 
 Writes are frontmatter-only and leave the body byte-identical, so they are safe
 while the note is open in Obsidian. A write also re-reads the file first and

package/dist/cli.mjs

@@ -7986,7 +7986,7 @@ The closest thing in the note is:
 Quote that, character for character.` : "";
   return fail(
     "quote-not-found",
-    "That text is not in the note. The quote has to be verbatim \u2014 copy it straight out of the listed note body, including its punctuation, capitalisation and spacing." + hint
+    "That text is not in the note. The quote has to be verbatim \u2014 copy it straight out of the listed note body, including its punctuation, capitalization and spacing." + hint
   );
 }
 function looseMatch(body, quote) {

package/dist/mcp.mjs

@@ -42976,7 +42976,7 @@ var StdioServerTransport = class {
 };
 
 // package.json
-var version2 = "0.1.4";
+var version2 = "0.2.0";
 
 // src/bin/vault.ts
 import { existsSync, statSync } from "node:fs";
@@ -43603,7 +43603,7 @@ The closest thing in the note is:
 Quote that, character for character.` : "";
   return fail(
     "quote-not-found",
-    "That text is not in the note. The quote has to be verbatim \u2014 copy it straight out of the listed note body, including its punctuation, capitalisation and spacing." + hint
+    "That text is not in the note. The quote has to be verbatim \u2014 copy it straight out of the listed note body, including its punctuation, capitalization and spacing." + hint
   );
 }
 function looseMatch(body, quote) {
@@ -43712,7 +43712,7 @@ server.registerTool(
   "obelisk_comment",
   {
     title: "Comment on a passage",
-    description: "Leave a comment on one passage of a note. It appears in the reader's Obsidian sidebar, badged as coming from an agent.\n\n`quote` is the anchor and must appear in the note verbatim \u2014 the same characters, punctuation, capitalisation and spacing. Copy it from obelisk_list; do not retype it or tidy it up. There is no way to pass a line or column, and you should not try to count them: the quote is the anchor and the tool does the arithmetic. If the quote is not found, or is found more than once, nothing is written and you are told which.\n\n`body` is markdown. To propose a specific rewrite, put it in a ```suggestion fenced block inside the body \u2014 its contents replace exactly the quoted passage when the reader clicks Apply, so a comment can explain itself and propose the change at once.",
+    description: "Leave a comment on one passage of a note. It appears in the reader's Obsidian sidebar, badged as coming from an agent.\n\n`quote` is the anchor and must appear in the note verbatim \u2014 the same characters, punctuation, capitalization and spacing. Copy it from obelisk_list; do not retype it or tidy it up. There is no way to pass a line or column, and you should not try to count them: the quote is the anchor and the tool does the arithmetic. If the quote is not found, or is found more than once, nothing is written and you are told which.\n\n`body` is markdown. To propose a specific rewrite, put it in a ```suggestion fenced block inside the body \u2014 its contents replace exactly the quoted passage when the reader clicks Apply, so a comment can explain itself and propose the change at once.",
     inputSchema: {
       note: noteArg,
       quote: external_exports.string().describe(
@@ -43770,7 +43770,7 @@ server.registerTool(
   "obelisk_resolve",
   {
     title: "Resolve or reopen a comment",
-    description: "Mark a comment settled \u2014 the reader's sidebar greys it out and drops it from the open count.\n\nThis is what closes the loop on a comment a person left for you: read it, make the edit in the note yourself, then resolve it. Resolving a comment you did not write is allowed, but it records that what the comment asked for has been done, so resolve only once it has.",
+    description: "Mark a comment settled \u2014 the reader's sidebar grays it out and drops it from the open count.\n\nThis is what closes the loop on a comment a person left for you: read it, make the edit in the note yourself, then resolve it. Resolving a comment you did not write is allowed, but it records that what the comment asked for has been done, so resolve only once it has.",
     inputSchema: {
       note: noteArg,
       id: external_exports.string().describe("The comment's id, from obelisk_list."),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obelisk-mcp",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "The Obelisk CLI and MCP server: comment on a passage of an Obsidian note, and propose suggested edits, from outside the app.",
   "mcpName": "io.github.zachhannum/obelisk",
   "bin": {
@@ -14,6 +14,7 @@
   },
   "scripts": {
     "dev": "node esbuild.config.mjs",
+    "lint": "eslint --max-warnings 0 .",
     "build": "tsc --noEmit --skipLibCheck && node esbuild.config.mjs production",
     "prepublishOnly": "npm run build",
     "shots": "npm run build && playwright test",
@@ -28,10 +29,13 @@
     "@playwright/test": "^1.62.1",
     "@types/node": "^20.14.0",
     "esbuild": "^0.21.5",
-    "obsidian": "^1.7.2",
+    "eslint": "9.37.0",
+    "eslint-plugin-obsidianmd": "0.4.1",
+    "obsidian": "^1.13.1",
     "obsidian-launcher": "^3.2.0",
     "tslib": "^2.6.3",
     "typescript": "^5.5.0",
+    "typescript-eslint": "8.61.1",
     "yaml": "^2.9.0",
     "zod": "^4.5.4"
   },