Skip to main content
Glama

List AppFlowy workspaces

list_workspaces

Get a read-only list of all AppFlowy workspaces, including name, ID, role, and member count. Use this to quickly overview available workspaces without making changes.

Instructions

List all AppFlowy workspaces (name, id, role, member count). Read-only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations provided, the description carries the full behavioral disclosure burden. It explicitly states 'Read-only', which signals no side effects, and 'List all' indicates the absence of filtering. This is meaningful beyond the name and title, though it does not mention authentication requirements or response formatting.

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?

The description is a single, efficient sentence with the core behavior front-loaded and the read-only caveat immediately following. Every part earns its place; there is no redundancy.

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

Completeness5/5

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

For a parameterless read-only list tool, the description is complete: it states the operation, the resource scope, the fields returned, and the side-effect-free nature. No additional details are required for an agent to invoke and interpret the result.

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?

This tool has zero parameters, so the baseline is 4. The description adds value by listing the output fields, which is the only semantic context an agent needs here.

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?

The description uses the specific verb 'List' with the resource 'AppFlowy workspaces' and explicitly names the returned fields: name, id, role, member count. This clearly distinguishes it from sibling tools like list_pages and search_pages.

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?

The description makes clear that this tool returns all workspaces, which is the correct context for calling it. It does not explicitly name alternatives or exclusion criteria, but the resource-specific wording is unambiguous enough for an agent to select it appropriately.

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