Skip to main content
Glama

Open document

nextcloud_open_document

Open a document for editing in Nextcloud and return a one-time editor URL for Office files or Markdown.

Instructions

Open one document for editing and return a one-time editor url for the connected account (Office for office files, Text for markdown).

POST /ocs/v2.php/apps/richdocuments/api/v1/document

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": {
      "path": "<path>"
    },
    "name": "nextcloud_open_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.0.0

TDQS

A3.5/5.0
Behavior4/5

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

The description adds useful behavior beyond the annotations: it returns a one-time editor URL for the connected account, chooses Office for office files and Text for markdown, and identifies the POST endpoint. It does not mention permission requirements or whether opening locks or creates a persistent editing session, but the annotations already cover safety traits.

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 brief and front-loads the core action and return value in the first sentence. The endpoint line adds minor technical detail but does not obscure the purpose, and there is no wasted prose.

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 simple one-parameter tool with annotations, the description covers the purpose and return value well enough. However, it leaves the sole input parameter unexplained and gives no explicit comparison with write_file or create_document, leaving gaps an agent must infer.

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?

The only parameter, path, has 0% schema description coverage and the description does not explain what the path should contain—relative vs absolute, file extension expectations, or format. 'Open one document' only weakly implies the path identifies the document, so the description fails to compensate for the bare 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 states a specific verb and resource: 'Open one document for editing' and return a one-time editor URL. This clearly distinguishes the tool's role from create_document or read_file by emphasizing an interactive editing session, though it does not explicitly name sibling alternatives.

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 phrase 'for editing' implies the tool is used when an interactive editor is needed, and the Office/Text distinction clarifies editor selection. However, there is no explicit guidance on when to use this instead of write_file or create_document, and no exclusions are stated.

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