Skip to main content
Glama

List Markdown Documents

list_articles
Read-onlyIdempotent

List or search Markdown Documents across all authorized workspaces by default, grouped by workspace, without returning full content. No workspace choice is needed for a general listing or search. Pass workspaceName or workspaceId only to narrow the search to a particular workspace. Results are bounded; use query to search by title, and nextCursor to request another page with the same workspace selection and query.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
queryNo
cursorNoOpaque nextCursor from a previous list_articles result.
contextYesDescribe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.
workspaceIdNoNarrow the list to this workspace ID. Omit to list across all authorized workspaces.
workspaceNameNoNarrow the list to this workspace name. Omit for a general listing or search across all authorized workspaces.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNo
totalYes
offsetYes
hasMoreYes
articlesYes
nextCursorNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / context
      Added value: +{
      +  "description": "Describe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.",
      +  "type": "string"
      +}
    • changedInput schema / properties / workspaceId / description
      Previous value: -"Internal workspace identifier when already available. Omit it when the user referred to a workspace by name or has only one workspace."New value: +"Narrow the list to this workspace ID. Omit to list across all authorized workspaces."
    • changedInput schema / properties / workspaceName / description
      Previous value: -"Human-visible workspace name. Prefer this over asking the user for an internal workspace identifier."New value: +"Narrow the list to this workspace name. Omit for a general listing or search across all authorized workspaces."
    • addedInput schema / required
      Added value: +[
      +  "context"
      +]
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, so the safety bar is low. The description adds real behavioral context: default scope is all authorized workspaces, results are grouped by workspace, output is bounded, and cursor must be reused with the same workspace selection and query.

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-loaded with the default scope and the key exclusion (no full content) before the optional-parameter guidance. The default-scope statement is restated twice ('across all authorized workspaces by default' / 'No workspace choice is needed'), a small redundancy but not enough to obscure the content.

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?

An output schema exists so return values need not be described, and the description covers scope, grouping, search, and pagination. The only omission is the limit/bound size, which the schema's maximum:50 does supply.

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 67% (limit and query lack descriptions), yet the description explains query as title search, nextCursor as pagination with matched selection/query, and the workspace params as narrowing filters. Only limit is left unexplained, so it meaningfully compensates for the coverage gap.

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 (list/search) and resource (Markdown Documents), plus two distinguishing scope facts: results are grouped by workspace and full content is NOT returned. This lets an agent separate it from read_article without opening either 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?

Gives clear context: workspace params are optional and only for narrowing, and query/nextCursor drive search and pagination. It does not name a specific sibling alternative (e.g. 'use read_article for content'), so it stops short of full when/when-not routing.

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