Skip to main content
Glama

Add Brain Document

aidelly_add_brain_document

Add a reference document to the workspace Brain from pasted text or from source_url, a public PDF, DOCX, TXT or Markdown file (10 MB max; web pages return 415, so send their text instead). Supply exactly one of text or source_url, plus an optional title, document_type and tags. The text is extracted and indexed for aidelly_search_brain. Requires workspace settings permission; a workspace holds at most 50 documents. Retry-safe: a repeat call with the same idempotency_key returns the original result.

Input Schema

NameRequiredDescriptionDefault
bodyNoOptional body override for endpoints with sparse parameter schemas.
tagsNo
textNoDocument text. Supply exactly one of text or source_url.
queryNoOptional query overrides for endpoints with sparse parameter schemas.
titleNo
brand_idNo
source_urlNoPublic http(s) URL of a PDF, DOCX, TXT or Markdown file (10 MB max). Web pages (HTML) are not accepted; send their text as text instead.
descriptionNo
workspace_idNoWorkspace to operate in: the `id` of a workspace returned by aidelly_list_workspaces. Optional for read operations; required when creating content.
document_typeNo
idempotency_keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior2/5

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

The description adds genuinely useful operational context beyond the annotations (workspace settings permission required, 50-document cap, HTML pages rejected with 415, text is extracted/indexed). However, it states the call is 'Retry-safe: a repeat call with the same idempotency_key returns the original result,' which asserts idempotent behavior while the annotation declares idempotentHint=false — a direct conflict on the retry semantics an agent uses to decide whether re-calling is safe.

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?

Four dense sentences, front-loaded with purpose and source options, then constraints, then operational behavior. Each sentence carries distinct information (format limits, XOR rule, indexing target, permission/quota, retry semantics) with no filler.

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 an 11-parameter create tool with no output schema, the description covers ingestion format, constraints, permissions, quota, and error behavior well. It omits what a successful call returns (e.g., a document id to feed into aidelly_get_brain_document), the only notable gap given no output schema exists.

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 45% across 11 parameters, so the description must compensate. It contributes the mutual-exclusivity rule ('exactly one of text or source_url'), the optional title/document_type/tags, and the idempotency_key retry semantics, but leaves body, query, brand_id, description and workspace_id partly unexplained, so it only partially fills the coverage gap.

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?

States a specific verb+resource ('Add a reference document to the workspace Brain') and names both ingest paths (pasted text or source_url file). It also distinguishes itself from sibling document tools by explaining that the text is extracted and indexed for aidelly_search_brain, so an agent knows this feeds the search corpus rather than, say, the upload-URL flow.

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?

Gives clear when-to-use rules: 'Supply exactly one of text or source_url' and 'web pages return 415, so send their text instead,' plus the retry condition. It stops short of contrasting with the closest siblings (aidelly_add_brain_entry vs. create_brain_document_upload_url), so it doesn't reach full alternative routing.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.