Skip to main content
Glama

Register a document

register_document

Register an existing document via a host-configured connection and return an opaque documentId for later edits. Provide the connectionId and source path; never include credentials.

Instructions

Register an existing document with a host-configured provider connection and return its opaque documentId. source is connection-specific: for a filesystem connection, a path under its root. Never pass credentials. Returns {connectionId, documentId, name, contentType, version}.

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": {
      "connectionId": "<connectionId>",
      "source": "<source>"
    },
    "name": "register_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
sourceYes
connectionIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare non-read-only, non-destructive, non-idempotent, closed-world, so the safety profile is covered. The description adds meaningful context beyond them: the identifier returned is opaque, the source is interpreted relative to the connection's configured root, and credentials must never be passed. Error or duplicate-registration behavior is still unstated.

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 short sentences, front-loaded with purpose, then the source constraint, then the return shape. No filler or restatement of the title.

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 two-parameter mutation with no output schema, the description supplies the return shape, the source interpretation rule, and a credential warning. It omits failure modes and duplicate-registration behavior, which are the main remaining gaps.

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 carry parameter meaning. It explains that source is connection-interpreted (a path under the filesystem root) and that connectionId refers to a host-configured provider connection, which is genuinely new information. connectionId's expected values are only implied, which keeps it below a 5.

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?

"Register an existing document with a host-configured provider connection" names a specific verb and resource, and the return of an opaque documentId makes it clearly not open_document or list_documents. An agent can distinguish it from siblings from the description alone.

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?

It gives an in-scope constraint ("source is connection-specific: a path under its root" and "Never pass credentials"), which is real usage guidance. However, it never states when to register versus open/inspect an already-open document, nor what happens if the document was already registered, so alternative selection is left implicit.

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