Skip to main content
Glama
Sign In
docmost-community-mcp

docmost-community-mcp

by dilruwanm
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

upload_attachment

Upload a local file to a page and get attachment metadata, including the URL path for accessing the file.

Instructions

Upload a local file to a page. Returns attachment metadata including the /api/files/:id/:name URL path.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "page_id": "<page_id>",
      "file_path": "<file_path>"
    },
    "name": "upload_attachment"
  }
}

Input Schema

NameRequiredDescriptionDefault
page_idYesPage UUID or slugId
file_pathYesAbsolute path to a local file

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already signal that this is a mutating operation (readOnlyHint=false) yet non-destructive (destructiveHint=false). The description adds useful return-value context by stating that attachment metadata, including the /api/files/:id/:name URL, is returned, though it does not mention permissions or size limits.

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?

A single sentence that fronts the action, names the target, and includes the key return detail. Every word contributes value and there is no redundancy.

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 simple two-parameter upload tool with fully documented parameters and no output schema, the description adequately covers the action, target, and return value. An agent can call this correctly with the information provided.

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 coverage is 100%, with both page_id and file_path documented. The description's 'local file' and 'to a page' wording adds no meaningful information beyond what the schema already provides, so the baseline score of 3 is appropriate.

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 plus resource: 'Upload a local file to a page.' This clearly distinguishes the tool from attachment-related siblings like get_attachment_info and search_attachments, which query rather than create.

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 gives a clear context for use: uploading a local file to a page. It does not explicitly name alternatives or exclusion conditions, but the action is straightforward and clearly different from the sibling read/query tools.

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

Deploy Server

Other Tools