Skip to main content
Glama
singlestore-mcp-server

singlestore-mcp-server

by jonasliesas

notebook_open

Read-only

Opens a single .ipynb notebook from the SQL folder or SAS Viya by reference, returning its content and Viya version/ETag needed to safely save changes.

Instructions

Read one .ipynb notebook from the SQL folder, or from SAS Viya by its ref (sas-content://<connection>/… or sas-server://…, see viya_files_browse with kind="notebook"); a Viya notebook's version (ETag) is what notebook_save checks before overwriting.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "notebook_open"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.8.1

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and the description stays consistent with a read operation. Beyond the annotations it adds genuinely useful behavior: the accepted ref schemes and the fact that a Viya notebook's version (ETag) is the token notebook_save validates before overwriting, which matters for a read-then-save workflow. It omits whether opening loads the notebook into editor/kernel state, which is the main remaining behavioral unknown.

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?

One front-loaded sentence with the primary action first, then the two sources, with the discovery hint and the notebook_save/ETag note as compact parentheticals. Dense but every clause carries real information; a slight readability cost from stacking three ideas in a single sentence.

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?

With no output schema and only a readOnlyHint annotation, the description carries the whole burden, and it never indicates what opening yields (cell contents, a handle, an editor state change) or whether a kernel/editor session must already exist. It is strong on locating and identifying the notebook but leaves the post-open flow underspecified.

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 0% (the single `name` property has no description), so the description must compensate, and it does: it defines the value domain as either a path in the SQL folder or a Viya ref URI of the form sas-content://<connection>/… or sas-server://…. It does not say whether the .ipynb extension is optional or how relative paths resolve, so it falls short of fully documenting the one parameter.

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 and resource ("Read one .ipynb notebook") plus two explicit source locations: the SQL folder or a SAS Viya ref. It also names the sibling relationships (viya_files_browse for discovery, notebook_save for the overwrite check), so an agent can distinguish it from notebook, notebook_run, and notebook_save without reading any schema.

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?

Implies when to use it (opening an existing .ipynb by name/path or by Viya ref) and explicitly routes the agent to viya_files_browse with kind="notebook" to obtain a Viya ref. It does not state exclusions or contrast with neighboring open-style tools such as sql_editor_open_file, but the context is clear enough to select correctly.

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

Deploy Server

Other Tools