Skip to main content
Glama

sharedoc-mcp

Agent-generated Markdown → a link you can hand to anyone. GitHub gists today, your own server tomorrow.

English | 繁體中文

npm npm downloads MCP Registry Release License Node MCP Claude Code Codex

Add to Cursor Install in VS Code

An MCP stdio server — works in Claude Code, Codex CLI, and any MCP client — that gives your agent 9 tools to publish, update, search, and revoke shareable documents. Two pluggable backends behind one interface: gist (zero setup, rides your logged-in gh CLI) and selfhost (SQLite on your machine, passwords, enforced expiry).

When a backend can't honor a parameter (e.g. password on gist), it returns a clear error instead of silently ignoring it.

Why?

AI agents produce Markdown constantly — reports, research digests, meeting notes. Getting that to another human usually means copy-pasting walls of text into a chat window.

Without sharedoc-mcp                  With sharedoc-mcp
────────────────────                  ─────────────────
copy a wall of text into chat         "share this as a doc"
paste again for each person           one link for everyone
content lives in chat scroll          revoke / extend / append later
"can you password it?"  …no           selfhost backend: bcrypt + expiry

Where do those Markdown digests come from? Often another skill — e.g. audio-tldr turns videos and podcasts into Markdown digests; sharedoc-mcp turns them into links.

Related MCP server: PasteAI

Features

  • ✓ 9 MCP tools: create / append / update content / extend / reset password / rename / revoke / delete / search

  • sharedoc-mcp serve daemon mode — selfhost links keep working after your MCP client closes

  • ✓ Content search: find old share links by what's in them, not just the title

  • GET /healthz — identity-aware health probe for external monitoring / restart automation

  • ✓ Two backends, one interface — switch with a single env var, tool schemas stay identical

  • Gist backend (default): secret gists via your logged-in gh CLI — no tokens to manage, nothing new to host

  • Selfhost backend: docs stay on your machine (SQLite via built-in node:sqlite — zero native modules)

  • ✓ Server-verified passwords (bcrypt) with rate-limited attempts — 5/minute, HTTP 429, counters persisted in SQLite so a restart can't reset them (selfhost)

  • ✓ Enforced expiry (410) and revoke with a 7-day content-purge grace (selfhost); lazy expiry cleanup (gist)

  • ✓ Markdown rendered through marked + sanitize-html — scripts, event handlers, and javascript: URLs in shared content are stripped

  • ✓ Viewer binds 127.0.0.1 only, answers with a strict security-header set (CSP default-src 'none', nosniff, DENY framing, no-referrer, no-store) — exposure is a tunnel you control (recipes below)

  • ✓ Local index for search_shared_docs + create dedup (identical unprotected retries within 5 min return the same URL; a retry that adds a password/expiry always creates a new doc)

  • search_shared_docs supports offset pagination (hasMore in the response) and, on selfhost, view stats (viewCount/lastViewedAt, counted on a successful render only)

  • Docker one-liner for the standalone serve daemon, defaults to the same 127.0.0.1-only binding as everywhere else

  • ✓ Two MCP clients can share one data dir: SQLite WAL + busy timeout, graceful port sharing

  • ✓ 110 offline tests; npm test passes on a clean checkout

Install

Requires Node.js ≥ 22.13.0. Gist backend additionally needs GitHub CLI logged in (gh auth login).

Option A — Claude Code (one line):

claude mcp add sharedoc --scope user -- npx -y sharedoc-mcp@^2

Option B — Codex CLI (~/.codex/config.toml):

[mcp_servers.sharedoc]
command = "npx"
args = ["-y", "sharedoc-mcp@^2"]

Option C — Cursor (one click): hit Add to Cursor, or merge into ~/.cursor/mcp.json:

{ "mcpServers": { "sharedoc": { "command": "npx", "args": ["-y", "sharedoc-mcp@^2"] } } }

Option D — VS Code (one click): hit Install in VS Code, or from a terminal:

code --add-mcp '{"name":"sharedoc","command":"npx","args":["-y","sharedoc-mcp@^2"]}'

Option E — any other MCP client: run npx -y sharedoc-mcp@^2 as a stdio server.

Why @^2? A bare npx -y sharedoc-mcp resolves the latest published version on every cold start — a future 3.0 could change behavior (or remove a tool) under you without warning. @^2 follows 2.x fixes but never crosses a breaking major; pin an exact version (@2.2.0) if you want zero drift.

Pick your backend

🅰 gist (default)

🅱 selfhost

Setup

none — uses your logged-in gh CLI

none extra — data stays on your machine

Doc lives on

GitHub (secret gist)

your machine (SQLite)

Link reachable

anywhere, immediately

localhost — add a tunnel to share externally

Password

✗ (the secret URL is the protection)

✓ server-verified (bcrypt), rate-limited

Expiry

lazy — expired gists deleted on next use

enforced — expired links return 410

Revoke

gist deleted immediately, irreversibly

immediate 410, content purged after 7-day grace

View stats

✗ (GitHub's gist API exposes no view-count data)

✓ viewCount + lastViewedAt, counted on a successful render only

Gist quickstart

Ask your agent to "share this as a doc" — it calls create_shared_doc and returns a secret gist URL. Secret gists are not listed publicly and the URL is unguessable, but anyone who has the link can read it — that's the whole security model of this backend. Need passwords? Use selfhost.

A local index (~/.config/sharedoc-mcp/index.json) tracks what you've shared, powering search and expiry cleanup. Expiry here is lazy: expired gists are deleted the next time any tool runs, not at the exact expiry moment.

Selfhost quickstart

claude mcp add sharedoc --scope user --env SHAREDOC_BACKEND=selfhost -- npx -y sharedoc-mcp@^2

Docs live in SQLite at ~/.local/share/sharedoc-mcp/; a viewer serves them at http://127.0.0.1:8377. To share beyond your machine, put a tunnel in front and set SHAREDOC_PUBLIC_URL:

Links that outlive your editor: in MCP mode the viewer dies with the MCP client — close Claude Code and selfhost links stop answering until the next session (data is safe in SQLite). Run the standalone daemon to keep links alive around the clock:

npx -y sharedoc-mcp@^2 serve   # viewer only, same DB — keep it running via launchd/systemd/tmux (Windows: Task Scheduler or NSSM)

MCP clients detect the daemon already owns the port and simply use it.

When to set this up: the moment you first hand a link to someone else — do it together with your tunnel (both should be long-running, e.g. under launchd/systemd). Until then the MCP-mode viewer is enough, and gist-backend users never need it.

Recipe

Fits you if

Setup

Tailscale private (recommended)

recipients are your own devices / people you can invite to your tailnet

tailscale serve --bg 8377https://<machine>.<tailnet>.ts.net, reachable only inside your tailnet — nothing is exposed to the public internet

Tailscale Funnel

share with anyone, no domain

tailscale funnel 8377 → same stable URL, but public

Cloudflare named tunnel

you own a domain

domain on Cloudflare, cloudflared tunnel create + route a hostname to http://127.0.0.1:8377

cloudflared quick tunnel

one-off sharing

cloudflared tunnel --url http://127.0.0.1:8377 → random URL, changes every restart

Own a domain? Cloudflare named tunnel, step by step

A branded, stable share URL like https://docs.example.com/docs/<uuid> — TLS handled by Cloudflare, works from behind NAT:

# one-time setup (domain already added to Cloudflare — the free plan is enough)
cloudflared tunnel login
cloudflared tunnel create sharedoc
cloudflared tunnel route dns sharedoc docs.example.com

~/.cloudflared/config.yml:

tunnel: sharedoc
credentials-file: ~/.cloudflared/<tunnel-id>.json
ingress:
  - hostname: docs.example.com
    service: http://127.0.0.1:8377
  - service: http_status:404

Run cloudflared tunnel run sharedoc (or install it as a service for always-on), and register the MCP server with the public URL:

claude mcp add sharedoc --scope user \
  --env SHAREDOC_BACKEND=selfhost \
  --env SHAREDOC_PUBLIC_URL=https://docs.example.com \
  -- npx -y sharedoc-mcp

Extras this unlocks: Cloudflare's DDoS protection comes free; you can layer WAF rules, or put Cloudflare Access (SSO) in front of everything except the share paths — an "SSO inside, password-protected shares outside" split.

Alternative — always-on without a home machine: run sharedoc-mcp on a VPS (where your agent also runs) and point nginx/caddy at 127.0.0.1:8377 with your domain and auto-TLS; no tunnel needed.

Docker

Runs the same standalone serve daemon as above, in a container:

docker build -t sharedoc-mcp .
docker run -d --name sharedoc \
  -p 8377:8377 \
  -e SHAREDOC_BIND_HOST=0.0.0.0 \
  -v sharedoc-data:/data \
  sharedoc-mcp
  • -v sharedoc-data:/data persists docs.db in a named volume — recreating the container keeps your docs.

  • SHAREDOC_BIND_HOST=0.0.0.0 is required to reach the container at all. The viewer binds 127.0.0.1 by default — same as every other deployment in this README — and inside a container that's unreachable through docker run -p, because -p forwards to the container's network interface, not its loopback. Without this env var, docker logs will show the viewer listening, but the mapped host port will refuse every connection.

  • Setting it to 0.0.0.0 means any process that can reach the container's exposed port reaches the viewer, unauthenticated by network position — the same exposure tradeoff as running any other unauthenticated app in a container without a proxy in front. Put it behind the same kind of front door as any other selfhost recipe above (a reverse proxy on the host, a Tailscale sidecar, a Cloudflare tunnel) rather than publishing -p 8377:8377 straight to the internet. Password-protecting individual docs (this backend's built-in feature) is not a substitute for that.

  • If the address recipients will use differs from http://<host>:8377 (a reverse proxy, a domain, a tunnel), set SHAREDOC_PUBLIC_URL too — the container has no way to infer it.

  • The MCP stdio server itself isn't meant to run in Docker — it needs a local process wired to an MCP client's stdin/stdout. Point your MCP client at npx -y sharedoc-mcp on the host as usual; only the standalone viewer daemon belongs in the container.

Environment variables:

Variable

Default

Meaning

SHAREDOC_BACKEND

gist

gist or selfhost

SHAREDOC_PORT

8377

viewer port (selfhost)

SHAREDOC_BIND_HOST

127.0.0.1

viewer bind address (selfhost) — 0.0.0.0 to reach it from outside a Docker container; see Docker for the exposure tradeoff before changing this

SHAREDOC_PUBLIC_URL

http://127.0.0.1:<port>

URL prefix in share links — set to your tunnel hostname

SHAREDOC_DATA_DIR

~/.local/share/sharedoc-mcp

SQLite location (selfhost)

SHAREDOC_INDEX_PATH

~/.config/sharedoc-mcp/index.json

local index (gist)

MCP_CALLER

default author attribution for created docs

The 9 tools

Tool

Does

create_shared_doc

title + Markdown (+ optional password / expires_in_hours / author) → share URL

append_to_shared_doc

append Markdown (not idempotent — a retry appends twice)

update_shared_doc_content

replace the entire content (title/password/expiry unchanged) — idempotent, safe to retry

extend_shared_doc

extend expiry by N hours

reset_shared_doc_password

set / change / remove (null) the password (selfhost only)

update_shared_doc_title

rename

revoke_shared_doc

kill the link, keep the record (see backend table for semantics)

delete_shared_doc

kill the link AND erase the record — irreversible; requires confirm: true (agents should get explicit user approval first)

search_shared_docs

no args = list newest links; title substring, body-text search (selfhost: full content; gist: opening excerpt), status filter, offset paging (hasMore in the response), view stats on selfhost

Privacy

Data flow, by backend:

  • Gist backend: your document content is uploaded to GitHub as a secret gist under your account — GitHub's terms and retention apply. The local index stays in ~/.config/sharedoc-mcp/ — it stores titles, URLs, timestamps, and the first 200 characters of each doc (for local content search); never the full content. Nothing is sent anywhere except GitHub via your own gh CLI.

  • Selfhost backend: content never leaves your machine unless you attach a tunnel — then it's served to whoever you gave the link (and the tunnel provider relays the traffic). Passwords are stored only as bcrypt hashes.

  • sharedoc-mcp itself has no telemetry and calls no third-party service of its own.

Security semantics, honestly

  • Gist links are bearer tokens: anyone with the URL reads the doc. Revoke deletes the gist immediately and irreversibly.

  • Selfhost passwords are verified server-side before content is served; only WRONG attempts are rate-limited (5/minute per source+doc; a correct unlock clears the counter), with counters persisted in SQLite — restarting the server does not reset them. Behind a tunnel, all external visitors share one source address, so the practical limit is 5/minute per doc — stricter than per-visitor; one person mistyping can briefly lock a doc for others.

  • There is deliberately no file-sharing tool: an arbitrary-path "share this file" tool is a prompt-injection exfiltration vector (.env, keys) — a hijacked agent could publish secrets. Removed rather than allowlisted.

  • The viewer never binds beyond 127.0.0.1. Whether and how it reaches the internet is entirely your tunnel's configuration.

Develop

git clone https://github.com/AugustusW/sharedoc-mcp.git
cd sharedoc-mcp
npm install
npm test        # builds, then runs 110 offline tests — gh CLI is mocked, HTTP tests hit 127.0.0.1 only

Versioning: every release bumps version in package.json, adds a CHANGELOG entry, and is published as a git tag + GitHub Release + npm. To get update notifications: Watch this repo (Custom → Releases). npx -y fetches the latest published version on each cold run; your index and docs DB live outside the package — updating never touches them.

Status

v2.2.0 (CHANGELOG) — core logic is covered by 110 offline unit/integration tests (the gh CLI is mocked; HTTP tests run against 127.0.0.1 only; no network needed). The full flows have been manually verified (2026-07-25: real secret-gist create/index/delete via the built server over stdio JSON-RPC, and the selfhost password flow end-to-end — form → wrong password 401 → correct password 200 → rate-limit 429 → revoke 410 — plus lsof confirmation of the 127.0.0.1-only bind) on:

  • macOS (Apple Silicon), Node v25 — gist + selfhost backends

Tunnel recipes are documented from the tools' standard behavior; Windows/Linux and real-tunnel end-to-end runs have not yet been verified — reports welcome. The manual pass above predates 2.2.0: its additions (update_shared_doc_content, view stats, pagination, Docker) are covered by the test suite but have not had an equivalent hands-on run.

License

MIT © AugustusW

Available Tools

9 tools
append_to_shared_docA

Append content to an existing shared doc. NOT idempotent: a retry appends twice — check with search_shared_docs before retrying. Accepts a doc id or URL.

ParametersJSON Schema
NameRequiredDescriptionDefault
contentYes
updated_userNo
doc_id_or_urlYes

TDQS

A3.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It explicitly discloses the non-idempotent behavior ('a retry appends twice'), which is critical mutation-behavior information. It does not mention authentication/permission requirements or the return format, but the idempotency disclosure is the most operationally important trait for an append operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, front-loaded with the core action in sentence one and the critical non-idempotency warning in sentence two. Zero waste, all sentences earn their place. Could be slightly more structured, but it's tight and well-paced.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations and no output schema, the description should add more: the 'content' semantics, what 'updated_user' means, and whether there's a size limit on appends. The non-idempotency and doc-id-or-url notes are valuable, but the parameter semantics gap and lack of return-value expectations leave it incomplete for a 3-parameter tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% (no descriptions on any of the 3 parameters). The description mentions doc_id_or_url (accepts a doc id or URL) and implies content, but it never documents what 'content' represents (plain text? markdown? formatting restrictions?) or what 'updated_user' means semantically. With 0% schema coverage and 3 parameters, the description only partially compensates.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb+resource+action: 'Append content to an existing shared doc.' It clearly distinguishes this from create_shared_doc (create new) and extend_shared_doc (extend). It could more explicitly contrast with extend_shared_doc, which is its nearest sibling, but the append-vs-create distinction is clear.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides clear usage context: it operates on existing docs, accepts a doc id or URL, and explicitly warns the agent to check with search_shared_docs before retrying due to non-idempotency. It doesn't say when NOT to use it vs extend_shared_doc (the nearest sibling), but the idempotency warning and pointer to search_shared_docs offer practical guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_shared_docA

Create a shared Markdown doc, returns a public URL. Backend semantics differ: gist backend has no password support (secret URL is the protection) and lazy expiry; selfhost backend enforces both.

ParametersJSON Schema
NameRequiredDescriptionDefault
titleYes
authorNo
contentYes
passwordNo
expires_in_hoursNo

TDQS

A3.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full disclosure burden and does well: it warns that password support is unavailable on gist backend, that expiry behavior is lazy on gist, and that selfhost enforces both. This is genuinely useful behavioral context beyond the bare schema for a mutation tool that creates a public resource.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences with zero waste. First sentence states action and return value; second delivers the critical backend caveat. Information-dense and front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is moderately complex (creation with backend-dependent behavior, 5 params, no output schema or annotations), and the description covers the most important caveats. However, it leaves the absent output schema unaddressed (no statement of what the public URL looks like or its format), and the backend selection mechanism is unclear, making the completeness partial for a tool with this level of behavioral nuance.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so all 5 parameters (title, content, author, password, expires_in_hours) are undocumented in the schema itself. The description explains the semantics of password and expires_in_hours indirectly via backend differences, but says nothing about title, content, or author beyond their existence being obvious. It partially compensates for the low coverage but leaves key parameters unaddressed.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description states a clear verb+resource ('Create a shared Markdown doc') and notes it returns a public URL, distinguishing the creation action from siblings like update_shared_doc_title or revoke_shared_doc. However, it doesn't explicitly differentiate from append_to_shared_doc or extend_shared_doc, though those are clearly post-creation operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides meaningful backend-specific caveats (gist vs selfhost differences in password/expiry behavior) which inform when/whether to set password and expires_in_hours parameters. However, it doesn't give explicit when-to-use guidance or name alternative tools, and the backend distinction is somewhat opaque without more context on how to choose backend.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

delete_shared_docA

Permanently delete a shared doc: the link dies AND the record disappears from search — unlike revoke_shared_doc, no history is kept. Irreversible on both backends. Requires confirm: true, which you must only pass after the user explicitly approved the permanent deletion; prefer revoke_shared_doc for routine takedowns.

ParametersJSON Schema
NameRequiredDescriptionDefault
confirmYes
doc_id_or_urlYes

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of disclosure. It comprehensively covers: permanence (irreversible), the dual effects (link death + search removal), no history retention, the confirmation requirement, and the alternative tool recommendation. This is exemplary disclosure for a destructive tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three packed sentences, each earning its place: the first states what happens, the second warns irreversibility, the third provides usage guardrails. Information-dense with zero filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive 2-parameter tool with no annotations and no output schema, the description is remarkably complete. It covers purpose, behavioral consequences, safety requirements, and alternative selection, leaving almost nothing for the agent to guess.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It explains the confirm parameter's semantics thoroughly (must only pass after explicit user approval). However, doc_id_or_url is not elaborated—the agent must infer it accepts an ID or URL from the parameter name. Partial compensation; the confirm context is strong but doc_id_or_url lacks detail.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb (delete), resource (shared doc), and the two key behaviors: the link dies and the record disappears from search. It also explicitly differentiates from revoke_shared_doc ('unlike revoke_shared_doc, no history is kept'). This is specific and distinguishes from siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Excellent when/when-not guidance: explicitly states to prefer revoke_shared_doc for routine takedowns, and requires confirm:true only after explicit user approval. It also warns the operation is irreversible on both backends, giving the agent clear guardrails for appropriate invocation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

extend_shared_docA

Extend a doc expiry by N hours (for "N days" multiply by 24 first). On the gist backend expiry is enforced lazily (cleanup on next use).

ParametersJSON Schema
NameRequiredDescriptionDefault
hoursYes
doc_id_or_urlYes

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It discloses a useful behavioral trait: expiry is enforced lazily on the gist backend (cleanup on next use), which is genuinely helpful context. However, it doesn't disclose what happens to the returned data, whether the operation is reversible, or any error/edge-case behavior (e.g., what if the doc is already expired). The lazy-enforcement note is a real value-add but coverage is partial.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences with zero waste. The first states the operation clearly, and the second adds a practical usage hint plus a behavioral disclosure. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool (extending expiry) with no annotations and no output schema, the description is moderately sufficient. It clarifies the hours semantic and the lazy cleanup behavior, but omits details an agent might need: max extension limits, whether expiry can only be extended (not reduced), and the return value format. Given only 2 simple params, this is adequate but not fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate, and it partially does. The description explains the 'hours' parameter semantics clearly (multiply days by 24), which is the most important semantic detail. However, it doesn't elaborate on 'doc_id_or_url' format (whether a full URL or just an ID is accepted), leaving some gap for a 0%-coverage schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb+resource ('Extend a doc expiry') and clearly states the action on a shared doc. The tool name 'extend_shared_doc' is reinforced by the description but the description adds the key detail that it extends by N hours, distinguishing it from sibling tools like create, append, reset, update, revoke, and delete.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear usage context: it extends expiry by hours with an explicit note on how to convert days to hours ('for N days multiply by 24 first'). It doesn't explicitly say when NOT to use this vs alternatives, but the sibling set makes task separation obvious (extend vs create/append/reset/update/revoke/delete are distinct operations).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

reset_shared_doc_passwordC

Reset a doc password (null removes protection). Selfhost backend only.

ParametersJSON Schema
NameRequiredDescriptionDefault
new_passwordYes
updated_userNo
doc_id_or_urlYes

TDQS

C2.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description mentions 'Selfhost backend only' which is a useful operational constraint, and that null removes password protection. However, there are no annotations, so the description carries the full burden for behavioral disclosure. It doesn't clarify whether the password change is destructive/reversible, whether it affects other users' access, or what happens to the password on selfhost vs cloud versions. For a mutation tool with zero annotation coverage, this is a meaningful gap but the 'Selfhost backend only' note adds some context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely brief - two clauses that convey the purpose and the null behavior plus the backend constraint. Every element earns its place. However, it's borderline under-specified, so it leans more toward conciseness than substantive content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations, no output schema, and 0% schema description coverage on parameters, the description does not compensate. It fails to explain the return value, side effects on shared access, or the 'updated_user' parameter's role. It also doesn't clarify whether resetting to null makes the doc accessible to everyone or just removes the password entirely. The description is incomplete given the tool's complexity and the absence of any structured enrichment.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must explain the parameters, but it barely does. The description touches on new_password via the 'null removes protection' note, and implies doc_id_or_url is a resource identifier, but does not explain updated_user at all. It doesn't clarify whether doc_id_or_url accepts a URL or just an ID format, and 'null removes protection' is the only real semantic contribution beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description has a specific verb+resource ('Reset...password') and clarifies the null-removes-protection behavior. However, it does not distinguish itself from siblings like update_shared_doc or revoke_shared_doc. The core action is clear but the scope vs sibling operations is ambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool over siblings such as revoke_shared_doc or update_shared_doc. The 'Selfhost backend only' constraint is a limited usage note, but there's no when-to-use, prerequisites (e.g., existing password required?), or exclusion criteria. No alternatives are mentioned.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

revoke_shared_docA

Revoke a shared doc: the link stops working but the record stays searchable. Gist backend: the gist is deleted immediately and irreversibly. Selfhost backend: revoked with a 7-day grace before content is purged. To erase the record entirely, use delete_shared_doc.

ParametersJSON Schema
NameRequiredDescriptionDefault
updated_userNo
doc_id_or_urlYes

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It does this thoroughly: states the link stops working, the record remains searchable, describes backend-specific differences (immediate irreversible deletion on Gist vs 7-day grace on Selfhost), and clarifies that this is not the tool for full record removal.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences deliver high information density with zero filler. Each sentence earns its place: the first states core behavior, the second covers backend differences, and the third directs to the sibling tool for the full-erase use case.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a relatively simple revoke operation with no output schema and no annotations, the description covers the essential behavioral dimensions well. The only gap is parameter documentation (doc_id_or_url format, updated_user purpose), but the core operation semantics are complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate for both parameters. It doesn't explain what doc_id_or_url should contain (a document ID or a URL format) or what updated_user is for. The description provides zero parameter-level guidance despite having two undocumented parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb+resource ('Revoke a shared doc') and clearly states the effect: the link stops working but the record stays searchable. It distinguishes itself from the sibling delete_shared_doc tool by naming it explicitly as the alternative for full erasure.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides explicit guidance on when to use this tool vs delete_shared_doc, and even differentiates behavior between Gist and Selfhost backends. This gives the agent clear decision rules for which action to pick.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_shared_docsA

Find previously shared docs and their links. Call with NO arguments to list the newest docs (each result includes its share URL, and on the selfhost backend, viewCount/lastViewedAt — gist returns those as null, GitHub exposes no gist view-count data). title_query filters by title substring; content_query searches body text (selfhost: full content; gist: the opening excerpt only); status filters active/revoked/expired; limit max 100 (default 20); offset pages past it (must be >= 0) — hasMore in the response tells you whether to fetch another page at offset + limit.

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNo
offsetNo
statusNo
title_queryNo
content_queryNo

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden and does so thoroughly. It discloses backend differences (selfhost returns viewCount/lastViewedAt; gist returns null), pagination behavior (limit max 100 default 20, offset >= 0, hasMore in response), and search semantics (content_query searches full content on selfhost but only the opening excerpt on gist). This goes well beyond the schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single dense sentence, packed with all necessary details. It front-loads the purpose and then covers parameters and backend quirks. Some might find it slightly run-on, but every phrase earns its place; a structured list could improve readability slightly, hence 4 rather than 5.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations, no output schema, and 5 parameters, this description is exceptionally complete. It explains return data (share URL, viewCount/lastViewedAt), pagination semantics (hasMore, offset+limit), backend variations, and all filters. Nothing critical is missing for an agent to invoke and interpret the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 5 properties, all with no descriptions, but the tool description explains each one: title_query (title substring), content_query (body text with backend caveat), status (active/revoked/expired), limit (max 100, default 20), offset (must be >= 0, used for pagination). This fully compensates for the schema's lack of descriptive coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb+resource: 'Find previously shared docs and their links.' It clearly distinguishes this from sibling tools, which are all mutating operations (create, update, revoke, delete). It also clarifies the no-argument default behavior, reinforcing purpose.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage context is clear: call with no arguments to list newest docs, or use filters (title_query, content_query, status, limit, offset) to narrow results. It does not explicitly name alternatives, but the sibling set is all write/update/delete operations, making the read-only search role obvious. No exclusions are needed beyond that.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

update_shared_doc_contentA

Replace the entire content of an existing shared doc (title, password, and expiry are left unchanged). Idempotent: unlike append_to_shared_doc, calling it twice with the same content is safe to retry — the result is the same either way. Accepts a doc id or URL.

ParametersJSON Schema
NameRequiredDescriptionDefault
contentYes
updated_userNo
doc_id_or_urlYes

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the burden of disclosing behavior. It explicitly reveals idempotency, that title/password/expiry are left unchanged, and that a doc id or URL is accepted. These are valuable behavioral traits beyond the basic operation, though return format or error conditions are not covered.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences long, with the main action front-loaded and additional details (idempotency, input format) in the second sentence. Every sentence adds value, with no fluff or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite having no annotations or output schema, the description provides key behavioral context: what the operation replaces, what remains unchanged, and idempotency for retries. It is reasonably complete for a simple mutation tool, though it omits return value details and does not explain updated_user.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It clarifies that doc_id_or_url accepts a doc id or URL and implies content is the replacement text, but it does not explain the updated_user parameter at all. Thus it adds partial meaning but leaves one parameter undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Replace the entire content of an existing shared doc' with a specific verb and resource. It also notes what is not changed (title, password, expiry) and explicitly distinguishes itself from append_to_shared_doc, making it unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides usage guidance by contrasting with append_to_shared_doc ('unlike append_to_shared_doc...') and mentioning idempotency for safe retries. It also specifies accepted input format ('Accepts a doc id or URL'), giving clear context on when to use this tool. However, it does not explicitly list other alternatives or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

update_shared_doc_titleC

Update a shared doc title (must be non-empty).

ParametersJSON Schema
NameRequiredDescriptionDefault
new_titleYes
updated_userNo
doc_id_or_urlYes

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It does not state whether this requires specific permissions, whether the change is reversible, what happens on failure, or any side effects. The only behavioral constraint disclosed is the non-empty title requirement.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single efficient sentence with zero waste. It front-loads the core purpose clearly. However, the brevity comes at the cost of missing important behavioral and parameter details.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations, no output schema, and 0% parameter coverage, this description is insufficient. It should explain permission requirements, error behavior for non-existent docs, and clarify the roles of updated_user and doc_id_or_url. The single line leaves too much for the agent to infer.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate for the 3 undocumented parameters. The description mentions 'title' which maps to new_title, but leaves doc_id_or_url and updated_user completely unexplained beyond the schema. The non-empty constraint adds value for new_title, but the other two params get no additional meaning.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb+resource action (update a shared doc title) with a clear constraint (must be non-empty). It distinguishes itself from siblings reasonably, since other tools like create/append/extend/delete are clearly different operations, though it could name the siblings explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool vs alternatives. It doesn't mention prerequisites (e.g., doc must exist, user must have permission), nor does it exclude cases where this tool would be inappropriate. The description is purely declarative with no usage context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. 2 tool updatesv2.2.0
    • Changedsearch_shared_docs1 field changed
      • addedInput schema / properties / offset
        Added value: +{
        +  "type": "number"
        +}
    • Addedupdate_shared_doc_content
  2. 8 tool updatesv2.1.4
    • First observedappend_to_shared_doc
    • First observedcreate_shared_doc
    • First observeddelete_shared_doc
    • First observedextend_shared_doc
    • First observedreset_shared_doc_password
    • First observedrevoke_shared_doc
    • First observedsearch_shared_docs
    • First observedupdate_shared_doc_title

TDQS

A3.9/5.0
Disambiguation5/5

Each tool targets a distinct operation on shared docs: create, append, replace content, extend expiry, reset password, update title, revoke, delete, and search. Even the two update-titled tools are clearly separated by attribute (content vs title), and revoke vs delete are explicitly differentiated in descriptions.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern using snake_case (e.g., create_shared_doc, update_shared_doc_title, search_shared_docs). Verbs are specific and the noun remains 'shared_doc(s)' throughout, making the pattern predictable and easy to navigate.

Tool Count5/5

With 9 tools, the server is well-scoped for managing shared documents. Each tool covers a necessary operation without redundancy, and the count fits comfortably within the ideal 3-15 range.

Completeness4/5

The surface covers create, read via search, full update of content/title/password/expiry, revoke, and delete, which is nearly complete for a document lifecycle. A minor gap is the lack of a direct 'get' tool to fetch full content of a single doc by ID, but search with content_query can partially work around this.

Maintenance

ActivityMaintained
ResponsivenessNo issues

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

  • A
    license
    A
    quality
    Not graded
    maintenance
    An MCP server that enables AI agents to instantly convert Markdown into beautiful, ready-to-deliver Word, PDF, HTML with sidebars, and Slideshow documents, bridging the "last mile" of AI content generation.
    7
    28
    1
    -
  • A
    license
    A
    quality
    B
    maintenance
    An MCP server that lets AI publish markdown documents to a clean, themed web UI. One tool call creates a shareable doc.
    8
    4
    MIT
  • A
    license
    Not graded
    quality
    A
    maintenance
    MCP server for structured document management of markdown and YAML files, with RBAC, git-based approval workflows, and semantic search, enabling agents to read, edit, and maintain documents under governance.
    MIT
  • A
    license
    Not graded
    quality
    A
    maintenance
    MCP server for Nyxdoc, a document system where humans and external agents collaborate on documents with version history, agent to-dos, and workspace permissions.
    MIT

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/AugustusW/sharedoc-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server