Skip to main content
Glama

create_doc

Create a document in an Outline collection by providing title, text, and collection ID. Supports optional publishing for immediate visibility.

Instructions

[requires: docs.create] Create a document in a collection.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYes
titleYes
publishNo
collectionIdYes
Behavior2/5

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

The description includes a permission requirement ('requires: docs.create'), which is a useful behavioral constraint. However, it does not describe what happens on success (e.g., returned object), failure conditions, or any side effects. With no annotations, the agent has limited insight into the tool's runtime behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact and front-loaded with the essential action. It does not waste words, though it sacrifices detail for brevity. The single sentence is meaningful and easy to parse.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 4 parameters, no output schema, and no annotations, this description is insufficient. It does not explain parameter semantics, return value, or usage boundaries, leaving the agent without enough context to invoke it reliably.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema provides property names and types but no descriptions. The description does not explain any parameters. 'publish' is ambiguous, and 'collectionId' is only vaguely hinted by 'in a collection.' With 0% schema description coverage, the description fails to compensate for the lack of parameter documentation.

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 clearly states the action (create), the resource (document), and the location (in a collection). It distinguishes from sibling tools like update_doc, delete_doc, and read_doc by explicitly indicating a creation operation.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives such as update_doc or read_doc. The description does not mention that this is for new documents only, nor does it reference any usage exclusions or prerequisites beyond a permission requirement.

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/pritesh-knowai/outline-rbac-mcp'

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