Skip to main content
Glama
Sign In
surfer-mcp

surfer-mcp

by office31
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

list_documents

List all currently open Surfer documents with their index, name, path, and saved state to manage and track your work.

Instructions

List the documents currently open in Surfer with their index, name, path and saved state.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full disclosure burden. 'List' and 'currently open' imply a non-mutating read scoped to open documents, and 'saved state' signals a returned attribute, but the description does not explicitly state read-only behavior, side effects, permissions, or empty-result behavior.

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?

It is a single front-loaded sentence with no wasted wording. It efficiently identifies the resource, runtime scope, and key returned fields.

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?

This is a simple zero-parameter read tool with an output schema, and the description covers what is listed plus key fields, so an agent can invoke it correctly. The minor omission is lack of usage routing versus sibling tools such as surfer_status.

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?

The tool has zero parameters, so there is no parameter meaning to add beyond the input schema. The baseline for zero parameters is 4.

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, 'List', and resource, 'documents currently open in Surfer', and enumerates returned fields including index, name, path, and saved state. It is clear, but it does not explicitly distinguish itself from sibling tools such as surfer_status.

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?

There is no explicit when-to-use or when-not-to-use guidance, and no alternatives are named. The name and phrase 'currently open in Surfer' imply the intended use, but an agent must infer this rather than being routed to or away from surfer_status.

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