Skip to main content
Glama
jonasliesas

singlestore-mcp-server

by jonasliesas

sql_editor_open_file

Read-only

Open a .sql file from the SQL Editor folder or SAS Viya, return its version for safe saves, and optionally add it to Recent.

Instructions

Read one .sql file from the SQL Editor's folder, or a file on SAS Viya.

``name``: a local file (relative to the SQL folder, or absolute), or a SAS Viya file ref
(``sas-content://<connection>/<path>`` or ``sas-server://<connection>/<path>``, see viya_files_browse);
a Viya file's result has its ``version`` (ETag), which sql_editor_save_file checks before overwriting.
``remember`` puts it on the Recent list (false when the editor only
re-reads its open file to compare it with the restored draft).

Input Schema

NameRequiredDescriptionDefault
nameYes
rememberNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.9.0
    • addedInput schema / properties / remember
      Added value: +{
      +  "default": true,
      +  "title": "Remember",
      +  "type": "boolean"
      +}
  2. Addedv0.8.1

TDQS

A4/5.0
Behavior4/5

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

readOnlyHint already declares this as a safe read operation. The description adds that Viya results include a version (ETag) checked by sql_editor_save_file before overwriting, and explains the Recent list effect of remember, including the specific false re-read comparison case. It omits error and permission behavior, but adds useful context beyond annotations.

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?

Front-loads the action and source, then details parameters in two dense backtick-labeled clauses. Efficient and information-rich, though the long parentheticals and nested cross-references make it slightly harder to scan.

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

Completeness4/5

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

For a read-only two-parameter tool with no output schema, the description covers source types, ETag/version behavior for Viya files, and the remember flag semantics. It omits authentication or Viya connection requirements and explicit return details beyond version, but is largely sufficient.

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

Parameters5/5

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

Schema coverage is 0%, so the description must carry parameter meaning. It documents name as a local relative or absolute path or a SAS Viya URI scheme and remember as Recent list inclusion with the false re-read comparison case, fully compensating for the empty schema descriptions.

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?

States a specific verb (Read) and resource (.sql file), and scopes the source to the SQL Editor folder or SAS Viya. It references sibling viya_files_browse for file refs but does not explicitly distinguish this tool from sql_editor_files or files_browse, so sibling differentiation is partial.

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

Usage Guidelines3/5

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

Provides context for the remember parameter and points to viya_files_browse for Viya paths, plus sql_editor_save_file for ETag checks. However, it does not say when to use this tool versus alternatives like sql_editor_files, viya_files_browse, or files_browse for listing or opening files.

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