Skip to main content
Glama

docbin

create_doc

Create a document and return its public URL. Re-using an existing name adds a new immutable version. Omit the name to get a random one. For content larger than ~10KB or any file already on disk, do NOT inline it here - run docbin push <file> [--name <doc>] in your shell instead (set DOCBIN_TOKEN to an API key from https://docbin.app/settings/keys). Inlining large content streams it through the model token-by-token and will time out.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoDocument name. A random slug is generated if omitted.
filesNoOptional: a multi-file group. When provided, supersedes content/content_type. The entry file is auto-selected (index/readme/main, else first). CROSS-FILE LINKS: to link from one file in the group to another, use a bare relative link to the sibling's filename, exactly as given in this `files` array - e.g. <a href="page2.html">. The viewer intercepts it and switches the active file (updating the left-pane selection and the URL). Do NOT use absolute URLs, slugs, ./ prefixes, or #file- hashes for cross-file links. In-page anchor links within a file (e.g. #section) work as normal.
contentNoThe HTML, Markdown, MDX, or code body of the document.
languageNoSyntax-highlight language hint, used when content_type is 'code' (e.g. 'rust').
visibilityNoDefaults to public. private = owner only; unlisted = anyone with the link; public = listed, searchable, and crawlable.
content_typeNoDefaults to html. 'mdx' renders Markdown with JSX components; 'code' renders a single syntax-highlighted block.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
appUrlYes
handleYes
rawUrlYes
deletedNo
snippetNo
versionYes
languageNo
visibilityNo
contentTypeNo

TDQS

A4.8/5.0
Behavior5/5

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

The description discloses important runtime behaviors beyond the annotations: that re-using a name creates a new immutable version, that omitting the name yields a random one, and that inlining large content streams through the model and times out. Annotations only declare readOnlyHint=false and destructiveHint=false, so these additions materially help an agent predict side effects and failure modes.

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 longer than average, but each sentence contributes: purpose, versioning behavior, random-name behavior, size threshold, shell alternative, why (timeout). It is front-loaded with the core action and uses no fluff, though it could be slightly tighter by trimming the inline example.

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?

The tool has an output schema, so return-value documentation is not required in the description. The description covers the essential operational constraints (size limits, alternatives, auth token for the fallback command) and the schema covers parameters and cross-file linking rules. Nothing needed for correct invocation is missing.

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 coverage is 100%, so the baseline is 3; the description adds extra meaning on top by explaining name-versioning semantics and the ~10KB practical limit for inline content, which the schema does not convey. It doesn't repeat every parameter, but the schema already covers files, content_type, visibility, and language in detail, so the incremental description value justifies a 4.

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 first sentence states a specific verb and resource: 'Create a document and return its public URL.' It also describes key behavioral facets (versioning on name reuse, random name generation), which makes the tool's function unmistakable against siblings get_doc and search_docs.

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?

The description explicitly tells the agent when NOT to use this tool ('content larger than ~10KB or any file already on disk, do NOT inline it here') and names a concrete alternative ('run `docbin push <file>` in your shell instead'), including the required DOCBIN_TOKEN setup. This is stronger than the typical 'use when...' guidance; it gives an exclusion plus a fallback.

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.

TDQS

A4.2/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: create, fetch, and search. There is no meaningful overlap between them, since get_doc retrieves exact content while search_docs returns matching document metadata.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern: create_doc, get_doc, search_docs. The plural in search_docs is idiomatic and does not create confusion.

Tool Count5/5

Three tools is a focused, appropriate count for this server's scope. Each tool covers a distinct and essential operation without redundancy or bloat.

Completeness3/5

The core workflow of creating, fetching, and searching is covered, and versioning handles updates. However, there is no delete operation and no way to list all documents without knowing a name, leaving notable lifecycle gaps.

Resources