Skip to main content
Glama

Alkemata Knowledge Gateway

Upload attached notebook

notebooks_upload_file

Publish an attached .ipynb file and return its public preview link in url and preview_url.

Input Schema

NameRequiredDescriptionDefault
fileYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false and destructiveHint=false, so the safety profile is partially covered. The description adds useful behavioral context by saying the tool publishes the file and returns a public preview link. However, it does not disclose permissions, overwrite behavior, duplicate handling, or other side effects of publishing.

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 a single front-loaded sentence with no wasted text. It states the action, input type, and return values efficiently.

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

Completeness3/5

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

The output schema exists, so the description does not need to fully explain return values, and mentioning url and preview_url is a useful touch. However, for a publish operation with a nested file object and 0% schema description coverage, the description is too thin about input requirements and usage context.

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

Parameters2/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 compensate for the nested file object. It only says the file should be an attached .ipynb, but does not explain required fields like download_url and file_id, or optional fields like file_name and mime_type. This leaves meaningful parameter semantics undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb and resource: publish an attached .ipynb file. It also states the return fields url and preview_url. It implicitly distinguishes itself from notebooks_upload_json by focusing on .ipynb files, though it does not name that sibling explicitly.

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?

There is no explicit guidance on when to use this tool versus alternatives such as notebooks_upload_json or openproject_upload_file. The only contextual cue is that the input should be an attached .ipynb file, which implies usage but does not state when-not or alternative conditions.

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.

Resources