rustpad-mcp
This server lets MCP clients read and edit pads on a Rustpad collaborative text-editor instance.
Read a pad's plain-text content (
get_document)Inspect pad metadata: length, revision, language, active users (
get_document_info)View server statistics: uptime, in-memory and persisted document counts (
get_stats)Create pads with optional content/language, using a chosen or random id (
create_document)Replace an entire pad's content, with confirmation required for non-empty pads (
set_document)Append text to a pad while preserving concurrent edits (
append_to_document)Search and replace an exact string, optionally replacing all occurrences (
replace_in_document)Set a pad's syntax-highlighting language (
set_language)
Provides tools to read and write collaborative text pads in a Rustpad instance, supporting operations such as creating, editing, and replacing document content via operational transformation to merge cleanly with concurrent human edits.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@rustpad-mcpcreate a collaborative todo list pad and share the link"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
rustpad-mcp
A Model Context Protocol (MCP) server for Rustpad, the efficient, minimal, self-hosted collaborative text editor.
Lets MCP clients like Claude Code, Claude Desktop or Codex read and write the pads of a Rustpad instance: fetch a document, create one, replace it wholesale or edit it in place.
Eight tools is the ceiling, not the floor: RUSTPAD_ALLOW_TOOLS=essential
registers a curated five instead, and a model picks the right tool far more
reliably from five than from eight — see
choosing which tools load.
Reads go through Rustpad's HTTP API; writes speak the operational-transformation
WebSocket protocol, so targeted edits (append_to_document, replace_in_document)
merge cleanly with what human collaborators type at the same time instead of
overwriting it. While the server edits a pad, it is visible to everyone in the pad as
a collaborator named rustpad-mcp.
The two edits that cannot be undone ask a person. Where the client supports
MCP elicitation, replacing a non-empty pad and search-replacing across more than
one match raise a real dialog that the model cannot answer on its behalf — and
the replace_in_document one says how many places are about to change. Where it
does not, they fall back to a two-call token, and say so rather than implying
somebody approved. ELICITATION=false takes that fallback deliberately; it
never removes the guard. See
Asking a person.

What makes it different
Real OT edits, not overwrites. append_to_document and replace_in_document
retain everything they do not touch, and the Rustpad server transforms concurrent
edits — a human typing in the same pad at the same moment loses nothing. The model
shows up in the pad as a named collaborator.
Built for an unauthenticated world. Rustpad has no accounts, so every pad is untrusted by definition. Everything that comes out of one — reads, metadata, even upstream error bodies — is explicitly marked as data, never instructions, before a model sees it.
Related MCP server: coda-mcp-server
Requirements
A reachable Rustpad instance (self-hosted; the server is stateless and needs no credentials — Rustpad has no authentication)
Node.js >= 22, or Docker
Configuration
Variable | Required | Description |
| yes | Base URL of the instance, e.g. |
| no |
|
| no |
|
| no | Comma-separated tool names, |
| no | Same syntax; removed from whatever |
| no |
|
The same URL serves the HTTP API, the WebSocket endpoint and the share links
returned by the tools (<RUSTPAD_URL>/#<pad-id>). The RUSTPAD_* booleans must
be exactly true. The server starts and lists its tools without configuration;
every call then fails with setup instructions.
ELICITATION is the odd one out twice over: it carries no prefix, so it reaches
every MCP server in the same environment, and a value that is neither true nor
false stops the server rather than falling back — it is the only variable here
that defaults to on, and a typo would otherwise leave the dialog running while
you believed it was off. A server started with it off prints one line saying so.
Keep in mind what Rustpad is: pads are ephemeral (lost on server restart
and after 24 hours of inactivity, unless the instance is run with
SQLITE_URI) and anyone who knows a pad id can read and write it. Do not
put secrets in pads.
Choosing which tools load
RUSTPAD_ALLOW_TOOLS and RUSTPAD_DENY_TOOLS take comma-separated tool names;
a trailing * matches a whole family. essential is a curated preset of
five: get_document, get_document_info, create_document, set_document, append_to_document.
RUSTPAD_ALLOW_TOOLS=essential
RUSTPAD_ALLOW_TOOLS=get_document,append_to_document
RUSTPAD_DENY_TOOLS=set_documentAn entry that matches no tool aborts startup and names it, so a typo cannot
silently hide a tool — an absent tool is not something anyone traces back to an
environment variable. A filtered tool is never registered, so it is absent from
tools/list and unknown to tools/call alike, exactly like a write tool under
RUSTPAD_READ_ONLY.
If you run several of these servers at once, mcp-hub
is the other answer — its /hub endpoint replaces every server's tools with six
meta-tools.
Installation
Claude Code
claude mcp add rustpad --env RUSTPAD_URL=https://rustpad.example.net -- npx rustpad-mcpClaude Desktop
{
"mcpServers": {
"rustpad": {
"command": "npx",
"args": ["rustpad-mcp"],
"env": {
"RUSTPAD_URL": "https://rustpad.example.net"
}
}
}
}Codex
~/.codex/config.toml:
[mcp_servers.rustpad]
command = "npx"
args = ["-y", "rustpad-mcp"]
[mcp_servers.rustpad.env]
RUSTPAD_URL = "https://rustpad.example.net"Docker
docker run -i --rm -e RUSTPAD_URL=https://rustpad.example.net ghcr.io/ni-c/rustpad-mcpThrough mcp-hub
A client that cannot spawn a local process — ChatGPT connectors, Claude on the web,
Cursor, LibreChat — reaches rustpad-mcp through mcp-hub: one
container serves many stdio MCP servers over Streamable HTTP, with an OAuth 2.1 login
behind a single password and long-lived tokens for the clients that cannot do OAuth. Its
/hub endpoint puts every server behind six meta-tools, so one connector reaches all of
them without N×tool schemas in the model's context, and it speaks both protocol revisions
— a question this server asks travels through it to the person at the far end.
Its /config/mcp.json uses Claude Code's format, so the entry is the one you already
have:
{
"mcpServers": {
"rustpad": {
"command": "npx",
"args": ["-y", "rustpad-mcp"],
"env": { "RUSTPAD_ALLOW_TOOLS": "essential" },
"denyTools": ["set_document"]
}
}
}allowTools and denyTools there are the hub's own per-server filter, which is not
the same thing as *_ALLOW_TOOLS in env — the difference, and the mistake it invites,
are in the client guide.
Tools
Tool | Description |
| Read the plain-text content of a pad |
| Content length, revision, language and the users editing right now |
| Server statistics (uptime, number of documents) |
| Create a pad (random or chosen id), optionally with content and language |
| Replace the entire content — a non-empty pad asks a person first |
| Append text; concurrent edits elsewhere survive |
| Exact search & replace via OT; asks when it changes more than one place |
| Set the Monaco syntax-highlighting language |
👤 asks a person through MCP elicitation · falls back to a two-call
confirm_token where the client cannot show a dialog.
With RUSTPAD_READ_ONLY=true only the first three are registered.
Structured output
Every tool declares an outputSchema and answers with structuredContent
alongside the text block, so a client can use the result without parsing prose.
The five write tools used to answer with a sentence — "Appended 12 characters
to pad …" — and the sentence is still there, in the text block:
{
"id": "notes",
"url": "https://rustpad.example/#notes",
"appended_characters": 12,
"characters": 137,
"note": "Pads are ephemeral: …",
}get_document answers {text} rather than the pad as the whole result, for the
same reason get_document_info has always been an object: a schema whose root
is a string is served to a 2025-era client rewritten as {result: …}, so the
tool would answer in two shapes depending on who asked. It is also where
empty and truncated can live — an empty answer used to be a sentence.
The two read tools that report pad content carry untrusted: true and
source: "rustpad" as fields. A pad is world-writable to anyone who knows its
id, including text this server wrote earlier, and a client that reads the
structured half would otherwise get it with no framing at all.
Not exposed, on purpose
No pad listing — Rustpad has no such API. Pads exist implicitly under every
id, so you have to know the ids you care about. get_stats reports how many
documents the server currently holds, but not their names.
No accounts, no permissions. Rustpad has neither, which is why every pad is treated as untrusted input rather than as something a login vouched for.
Safety
Pad content is world-writable and therefore untrusted: every read result is prefixed with a marker telling the model to treat it as data, never as instructions.
The two irreversible edits ask a person: a real dialog the model cannot answer on its behalf, bound to the pad and the exact replacement. Where the client cannot show one, a single-use token that only ever appears in a previous tool result — which proves the call was made twice with the same arguments, and nothing more. The fallback text says which of the two it was.
Tool results are size-capped; upstream error bodies are sanitized before they reach the model.
RUSTPAD_INSECURE_TLSrelaxes certificate validation only for the configured connection, never process-wide.
Documentation
The full guide, tool reference and security notes live at
rustpad-mcp.ni-c.de (source in docs/).
Development
npm install
npm run lint && npm run build && npm testThe test suite talks to an in-memory fake of rustpad-server (including OT
transformation of concurrent edits) over the real MCP protocol; no live
instance is needed. The architecture diagram and social card are generated —
edit docs/assets/architecture.source.svg and run npm run assets, never the
rendered copies.
Releasing
Releases are tag-driven. Bump package.json, move the [Unreleased] notes in
CHANGELOG.md under the new version, commit, then:
git tag -s vX.Y.Z -m "vX.Y.Z"
git push origin main vX.Y.ZThe release workflow publishes to npm via Trusted Publishing (OIDC, with provenance), pushes the multi-arch container image to GHCR, creates the GitHub release from the CHANGELOG section, and updates the entry in the official MCP registry.
Contributing
Issues, discussions and pull requests are welcome — see CONTRIBUTING.md. For vulnerabilities please use private reporting rather than a public issue; the policy is in SECURITY.md.
License
MIT © Willi Thiel
Available Tools
8 toolsappend_to_documentAppend to a padA
Appends text to the end of a pad, leaving everything else — including concurrent edits — untouched. The text is appended verbatim; include a leading newline to start a new line.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the pad, the part after # in its URL | |
| text | Yes | Text to append verbatim |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly states that the tool appends text verbatim without altering other content or concurrent edits. Annotations already indicate it is not read-only (readOnlyHint: false) and that it operates in an open-world setting (openWorldHint: true). The description adds essential context about nondestructive appending behavior, which goes beyond the annotation declarations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is only two sentences, each earning its place. The first sentence clearly states the action and its safe side effects, while the second provides a crucial usage tip. No filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity (2 required params, no output schema, no nested objects), the description is nearly complete. It covers the core behavior and a practical nuance. It does not mention failure modes (e.g., what happens if the pad does not exist), but the schema's required fields and pattern already constrain valid usage. With no output schema, the agent might wonder about the return value, but the tool's API likely mirrors the input confirmation (a minor gap).
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description restates that 'text' is appended verbatim, which the schema already says ('Text to append verbatim'). It adds the practical tip about including a leading newline to start a new line, which is helpful but not a semantic improvement over the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Appends') and resource ('a pad'), with explicit scope ('to the end of a pad'). It clearly distinguishes from siblings like 'set_document' (which replaces entire content) and 'replace_in_document' (which modifies specific parts) by emphasizing it only appends.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear guidance on when to use this tool (to add text without affecting existing content or concurrent edits). It implies the alternative of using a newline to start a new line. However, it does not explicitly exclude cases where one should choose 'replace_in_document' for editing middle content or 'create_document' for new pads.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_documentCreate a padA
Creates a pad, optionally with initial content and an editor language, and returns its shareable URL. Without an id a random one is generated. Pads are ephemeral: they are lost when the Rustpad server restarts and after 24 hours without an open connection. Anyone who knows the URL can read and edit the pad.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Desired pad id; omit to generate a random one | |
| text | No | Initial content | |
| language | No | Monaco editor language id for syntax highlighting, e.g. "markdown", "javascript", "rust", "plaintext" |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations indicate readOnlyHint=false (write operation) and openWorldHint=true (side effects). The description adds valuable behavioral context: pads are ephemeral (lost on server restart, after 24h inactivity), and anyone with the URL can read/edit. This goes beyond the annotations and informs the agent about data persistence and security implications.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences with no wasted words. The first sentence front-loads the main action and return value. The second sentence clarifies the id behavior. The third sentence explains ephemerality and access. Every sentence earns its place, and the structure is logical and easy to parse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has 3 optional parameters and no output schema, the description covers what it does, what it returns (URL), and important behavioral traits (ephemeral, public access). It does not mention error cases or prerequisites, but the annotations (openWorldHint=true) and sibling tools provide enough context for an agent to select and invoke this tool correctly. The description is reasonably complete for a creation tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents parameters. The description adds meaning by stating parameters are optional, explaining the id generation behavior ('Without an id a random one is generated'), and noting the return of a shareable URL (not in schema). This provides additional semantic context beyond the schema alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool creates a pad, optionally with initial content and language, and returns a shareable URL. It distinguishes from siblings like get_document (read), set_document (update), and append_to_document (modify) by focusing on creation. The verb 'creates' and resource 'pad' are specific and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for creating new pads but does not explicitly state when to use this tool versus alternatives (e.g., set_document for updating). It provides no exclusion criteria or guidance on when not to use it. While the purpose is clear, the lack of explicit when-to-use/when-not-to-use reduces the score.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_documentRead a padARead-only
Reads the current plain-text content of a pad. Pads are ephemeral: they are lost when the Rustpad server restarts and after 24 hours without an open connection. An empty result is ambiguous: Rustpad cannot distinguish an empty pad from one that never existed or has expired.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the pad, the part after # in its URL |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark the tool as readOnly and openWorld (true). The description adds critical behavioral detail not in annotations: pads are ephemeral (lost on server restart or after 24 hours of inactivity), and an empty result is ambiguous. This fully discloses behavioral traits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each earning its place: first states the action, second explains ephemeral nature, third clarifies ambiguity. No wasted words, front-loaded with the core purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description implicitly indicates the return is the plain-text content (by stating what is read). It covers the ephemeral nature and ambiguity. It could be slightly more explicit about the output format, but is otherwise complete for a simple read tool with good annotations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already provides 100% coverage for the single parameter 'id', including a regex pattern and description. The description does not add additional meaning to the parameter beyond what the schema provides, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb 'Reads' and resource 'plain-text content of a pad', clearly distinguishing this from sibling tools like 'get_document_info' (metadata) and mutation tools like 'create_document' or 'set_document'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides important context about when to use the tool by noting that empty results are ambiguous and pads are ephemeral. It implicitly advises against relying on a non-existent pad result, but does not explicitly state when to use alternatives like 'get_document_info'.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_document_infoInspect a padARead-only
Fetches metadata about a pad over the collaboration socket: content length, revision, editor language and the users who have it open right now. Pads are ephemeral: they are lost when the Rustpad server restarts and after 24 hours without an open connection.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the pad, the part after # in its URL |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, indicating a safe, non-mutating operation with potentially side effects. The description adds critical behavioral context: pads are ephemeral (lost after server restart or 24h without connection). This goes beyond annotations and clarifies data durability expectations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two focused sentences: the first states what the tool does and what it returns, the second gives critical ephemerality context. No wasted words; every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read operation with one parameter, no output schema, and full annotation coverage, the description is nearly complete. It could optionally mention that the metadata is real-time or that the socket connection affects latency, but this is sufficient.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the description adds no additional parameter details beyond what the schema provides. The schema already explains the pattern and meaning of 'id'. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description specifies the verb 'fetches' and the resource 'metadata about a pad', listing specific fields (content length, revision, editor language, open users). It clearly distinguishes from siblings like get_document (which presumably fetches content) and get_stats (which likely returns aggregate statistics).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for fetching live pad metadata via the collaboration socket, but provides no explicit guidance on when to prefer this over alternatives like get_document. It does not mention when not to use it or contrast with siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_statsServer statisticsARead-only
Reads the Rustpad server statistics: start time, number of documents currently held in memory, and the number persisted in the database (0 when the instance runs without persistence).
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint: true and openWorldHint: true. The description goes beyond annotations by detailing exactly what fields are returned (start time, memory count, persistence count) and explicitly flags the persistence count behavior under zero-persistence mode. This adds complete and valuable behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence that front-loads the verb and resource, immediately states the scope, and lists all returned data points concisely. Every word earns its place with no redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given zero parameters and no output schema, the description fully covers what the tool does, what it returns, and a behavioral note (zero-persistence mode). No gaps remain for an agent to be uncertain.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has zero parameters and 100% description coverage, so schema is complete. The description adds no parameter info, but no further meaning is needed—there are no parameters to document.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description starts with a specific verb ('Reads') and resource ('Rustpad server statistics'), then lists the three exact data points provided: start time, in-memory documents, and persisted documents. It clearly distinguishes this read-only server-level tool from the document-level siblings (get_document, get_document_info, etc.).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly states what the tool does and implicitly sets context for when to use it (checking server health/state). However, it does not explicitly state when not to use it or contrast it with similar siblings (e.g., get_document_info for document-level stats). Given the zero-parameter, read-only nature, the lack of exclusions is acceptable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
replace_in_documentSearch and replace in a padADestructive
Replaces an exact string in a pad with another. Only the matched ranges are edited, so concurrent edits elsewhere in the pad survive. By default the search string must match exactly once; set replace_all to change every occurrence.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the pad, the part after # in its URL | |
| search | Yes | Exact string to find (no regex) | |
| replace | Yes | Replacement; may be empty to delete the match | |
| replace_all | No | Replace every occurrence instead of requiring a unique match |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark this as mutable (readOnlyHint=false) and destructive (destructiveHint=true). The description adds unique behavioral context: 'Only the matched ranges are edited, so concurrent edits elsewhere in the pad survive,' clarifying the partial update strategy. It also confirms the search is exact (no regex). This goes beyond what annotations provide and is useful for agent reasoning.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences total, each adding distinct value: purpose, concurrency behavior, and parameter default. No filler words. The information is front-loaded with the primary action. Every sentence earns its place, making it easy to scan.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 4-parameter replacement tool with no output schema, the description covers the key behaviors: exact match, partial edit, uniqueness default, and replace_all alternative. It does not mention error cases (e.g., no match, multiple matches without replace_all) or return value, but given annotations handle safety signals, it is sufficiently complete. A minor gap is the absence of concurrency or lock warnings, but the concurrent edit statement partially addresses this.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so each parameter already has a description. The tool description reinforces the meaning of 'search' (exact string), 'replace' (may be empty), and 'replace_all' (default single-match). The additional context about default uniqueness is helpful but does not greatly extend beyond the schema. Baseline is 3, and description marginally meets it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description starts with 'Replaces an exact string in a pad with another,' using a specific verb ('replaces') and resource ('string in a pad'). It clearly distinguishes from siblings like set_document (full overwrite) and append_to_document (append), leaving no ambiguity about its targeted edit function.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description states 'By default the search string must match exactly once; set replace_all to change every occurrence,' which guides when to use the boolean parameter. It implies this tool is for exact string replacement, not regex or whole-document replacement, but does not explicitly name sibling alternatives for contrast. Context is clear enough for an agent to decide.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
set_documentReplace a padADestructive
Replaces the entire content of a pad. Replacing a non-empty pad requires confirmation: call once to receive a token, then again with that token. For targeted changes prefer replace_in_document, which leaves concurrent edits elsewhere in the pad intact.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the pad, the part after # in its URL | |
| text | Yes | Plain text content (up to 256 KiB, the Rustpad document limit) | |
| confirm_token | No | Confirmation token from a previous call of this tool with the same arguments. Omit on the first call. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and readOnlyHint=false. The description adds crucial context beyond annotations: it explains the confirmation token mechanism for non-empty pads, including the two-call workflow. This fully discloses the tool's behavioral traits for mutation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three concise sentences with no fluff. The first sentence states the core purpose. The second explains the critical workflow. The third provides usage guidance. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite having no output schema, the description is complete given the tool's complexity and rich annotations. It covers the purpose, workflow, and alternatives. The required vs. optional parameters are clear from the schema, and the confirmation token mechanism is fully explained.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all three parameters. The description does not add new meaning about individual parameters beyond stating the confirmation token workflow, which is already implied by the schema's description of the confirm_token field. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Replaces') and explicitly names the resource ('entire content of a pad'). It clearly distinguishes from the sibling 'replace_in_document' by highlighting the scope difference (whole content vs. targeted changes).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear guidance on when to use this tool (replacing entire content) vs. the alternative 'replace_in_document' (targeted changes, preserves concurrent edits). It also explains the confirmation workflow for non-empty pads, enabling correct agent reasoning.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
set_languageSet the editor languageA
Sets the syntax-highlighting language of a pad (Monaco language id, e.g. "markdown", "javascript", "rust"). Last writer wins; the change is visible to everyone who has the pad open.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the pad, the part after # in its URL | |
| language | Yes | Monaco editor language id for syntax highlighting, e.g. "markdown", "javascript", "rust", "plaintext" |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description clearly states 'Last writer wins; the change is visible to everyone who has the pad open,' which provides critical behavioral context beyond the annotations. Since annotations declare readOnlyHint: false (confirming mutation) and openWorldHint: true, the description adds value by explaining the real-time, collaborative conflict resolution behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with zero wasted words. The first sentence states the tool's core purpose with examples, and the second adds critical collaborative behavior. This is highly efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has only 2 parameters with full schema coverage and no output schema, the description is largely complete. It covers purpose, parameter values, and concurrency behavior. It could potentially note that no return value confirmation is provided (useful for confirmation), but overall it is thorough for this scope.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents both parameters well. The description reinforces the language parameter with examples ('markdown', 'javascript', 'rust') and specifies it uses Monaco IDs, which adds practical guidance beyond the schema pattern. It does not add details about the id parameter beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states the tool sets the syntax-highlighting language of a pad using Monaco language IDs, which is a specific verb+resource combination. It also includes examples of valid language IDs and a behavioral note about visibility, clearly distinguishing it from sibling tools like get_document or set_document.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies this tool should be used when you want to change the syntax highlighting language for collaborative editing, and notes that the change is visible to all viewers. However, it does not explicitly state when not to use it (e.g., for read-only access or other document features), nor does it reference sibling tools for 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.
8 tool updates
v0.1.1- First observed
append_to_document - First observed
create_document - First observed
get_document - First observed
get_document_info - First observed
get_stats - First observed
replace_in_document - First observed
set_document - First observed
set_language
TDQS
Each tool has a clearly distinct purpose: server stats, document content, document metadata, creation, full replacement, append, substring replacement, and language setting. No two tools overlap in functionality, and descriptions clearly differentiate them.
All tools follow a consistent verb_noun pattern with snake_case (e.g., get_stats, create_document, append_to_document). There is no mixing of conventions (e.g., no camelCase), and the verbs logically describe the action.
With 8 tools, the set is well-scoped for a collaborative text pad server: it covers reading, writing (multiple mutation strategies), and metadata operations without excess. This is an appropriate number for the domain.
The toolset covers creation, reading (both content and metadata), and several update operations (full replace, append, substring replace). However, a delete operation is missing, which is a notable gap for full CRUD lifecycle. Pads expire automatically, but an explicit deletion tool would improve completeness.
Maintenance
Related MCP Connectors
Collaborative word processor you can use with your agent.
A comprehensive Model Context Protocol (MCP) server that enables AI assistants to interact with yo…
The team layer for AI coding agents: shared contracts, collision alerts, E2EE sessions.
MCP-native collaborative markdown editor with real-time AI document editing
Related MCP Servers
- AlicenseNot gradedqualityAmaintenanceA Model Context Protocol server that enables AI assistants like Claude to read from, append to, and format text in Google Documents programmatically.3,208649MIT
- AlicenseBqualityDmaintenanceEnables AI-powered document automation and data manipulation with Coda.io through the Model Context Protocol, supporting document, page, table, row, and formula operations.266MIT
- FlicenseBqualityCmaintenanceEnables AI agents to interact with Overleaf projects directly, including creating projects, managing files, and editing documents in real-time using Overleaf's native Operational Transformation protocol.10-
- AlicenseNot gradedqualityCmaintenanceEnables AI agents to read, edit, and compile LaTeX documents in Overleaf projects with tracked changes via the Model Context Protocol.1MIT
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
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/ni-c/rustpad-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server