Skip to main content
Glama

create_document

Create a new knowledgebase document with Markdown content, saved as a draft by default or published instantly when requested, and get back the document ID.

Instructions

Create a new document in the Meet Rupert knowledgebase. Provide the body as Markdown; it is converted to the platform's rich-text format. By default the document is saved as a DRAFT (not searchable by the AI) so a human can review it before publishing — pass published:true to make it live immediately. Returns the new document's id. To embed images, upload each one with create_attachment (which takes a file path or an https:// URL — never image data) and place the markdownRef it returns in content. Every attachment:// reference is verified before saving: if one is unknown or belongs to another workspace the save fails naming the offending id, rather than storing a broken image.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYesThe document title (1–255 characters).
contentYesThe document body as Markdown (headings, lists, bold/italic, code blocks are supported). To include an image, call create_attachment first — passing it a file path or URL — and put the markdownRef it returns on its own line here. Never paste image data, base64 or a data: URI into this field; it will not render and large values are silently truncated in transit.
publishedNoIf true, the document is published and becomes searchable by the AI. Defaults to false (saved as a draft for a human to review and publish).
categoryIdsNoOptional list of category UUIDs (from list_categories). On create/update, tags the document. On ask tools, restricts retrieval to these categories.
Behavior5/5

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

With no annotations provided, the description carries the full burden and does so admirably. It discloses default draft behavior (not searchable), Markdown-to-rich-text conversion, return of the document id, and attachment verification failure modes. This is substantial and non-obvious behavior.

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 six sentences, dense yet perfectly organized: purpose, conversion behavior, draft default, return value, image embedding, and edge-case failure. Every sentence earns its place with no waste or 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?

Despite lacking an output schema and annotations, the description covers return value, failure behavior, default state, and interactions with sibling tools. It gives an agent everything needed to invoke the tool correctly and safely.

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 descriptions already cover all 4 parameters at 100%, setting a baseline of 3. The description adds extra context beyond the schema by explaining rich-text conversion and attachment reference verification, but most parameter semantics remain in the schema. A 4 is appropriate for the added context.

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 opens with 'Create a new document in the Meet Rupert knowledgebase,' which is a specific verb+resource that clearly identifies the tool's function. It distinguishes itself from siblings like update_document and create_attachment by focusing on new document creation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides explicit when-to-use guidance: explaining the draft/published default, directing users to create_attachment for images, and warning against pasting image data. This goes beyond generic context and gives actionable alternatives.

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

Install Server

Other Tools

Latest Blog Posts

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/deanjbrown/meetrupert-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server