Skip to main content
Glama

List docs

ls
Read-only

The docs (with their codes and links), projects and folders in one place: the workspace's Docs (no place), a project, or a folder. Each place has your role there (edit, comment or view; publishing needs edit).

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": "ls"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNo"project" or "project/folder", as publish takes it. Empty: the workspace's Docs and its projects.
workspaceNoWorkspace slug. Default: the only one, else the user's personal one.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, non-destructive, closed-world), and the description adds real behavioral content: entries come with codes and links, and each place carries the caller's role (edit/comment/view) with the constraint that publishing requires edit. Pagination and result-size behavior are not mentioned, keeping it from a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is short, but the single dense sentence opens with a noun phrase rather than an action, and the parenthetical '(no place)' plus semicolon-heavy role clause make it slower to parse than necessary. Content earns its place; the phrasing does not.

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 two-parameter, zero-required read tool with no output schema, the description conveys what comes back (docs, projects, folders, plus per-place roles) and how scoping works. Only return ordering/pagination details are absent, which is minor at this complexity.

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

Parameters3/5

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

Schema coverage is 100%, so both parameters are already documented, and the description's mention of 'no place' versus project versus folder largely restates the 'to' parameter semantics. It adds the useful hint that roles surface per place, but nothing about format or defaults beyond the schema.

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 names the resources returned (docs with codes and links, projects, folders) and the three scopes (workspace root, a project, a folder), which lets an agent tell this apart from deeper readers like read or get. It lacks an explicit verb such as 'list' and never contrasts itself with siblings like tree, so it stops short of a 5.

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?

Usage is only implied: the empty-default clause ('Empty: the workspace's Docs and its projects') signals browse-at-root behavior, and the role note hints at checking permissions before editing. There is no explicit when-to-use or when-to-prefer-an-alternative guidance versus tree, get, or read.

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