Skip to main content
Glama
esa MCP Server

esa MCP Server

Official
by esaio

Get category paths with pagination

esa_get_all_category_paths
Read-only

Retrieves paginated category paths with post counts and optional prefix, suffix, match, or exact filters to map a team's category structure for cleanup, migration, or similarity checks.

Instructions

Retrieves category paths in a team to understand the overall category structure. Perfect for category organization, cleanup, migration planning, or finding similar categories. Returns a paginated list of paths with post counts, sorted in lexicographic order. Supports filtering (prefix/suffix/match/exact_match) to find categories by pattern.

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

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (starts from 1)
matchNoFilter paths containing specified substring anywhere (e.g., 'doc' finds 'docs', 'dev/docs', 'documentation')
prefixNoFilter paths starting with specified string (e.g., 'dev' finds 'dev', 'dev/api', 'dev/docs')
suffixNoFilter paths ending with specified string (e.g., 'api' finds 'dev/api', 'backend/api')
perPageNoNumber of items per page
teamNameNoTeam name (required). Use esa_get_teams first to see available teams.
exactMatchNoFilter paths matching exactly (e.g., 'dev/api' matches only 'dev/api', ignores leading/trailing slashes)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.15.1
    • removedInput schema / additionalProperties
      Removed value: -false
  2. First observedv0.13.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare this is a safe read (readOnlyHint=true, destructiveHint=false, openWorldHint=false), so the bar is lower. The description still adds real behavioral value: results are paginated, include post counts, and are sorted lexicographically — facts an agent could not infer from the annotations alone.

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?

Three sentences, front-loaded with the core purpose and behavior, then filtering. The clause "Perfect for category organization, cleanup, migration planning, or finding similar categories" is mildly promotional but still informative enough to justify its space.

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?

With no output schema, the description usefully summarizes the return shape (paths with post counts, paginated, lexicographic order). Minor gaps remain: it doesn't clarify that teamName is effectively required (schema-level default is empty string and required-count is 0) or that esa_get_teams should be called first, though the schema does mention the latter.

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% and every parameter already carries a description with concrete examples (e.g., prefix 'dev' finds 'dev/api'). The description only restates that filters exist (prefix/suffix/match/exact_match) without adding syntax or precedence guidance beyond the schema, so baseline 3 applies.

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 and resource ("Retrieves category paths in a team") plus the scope/purpose of understanding overall category structure. It does not, however, distinguish itself from close siblings like esa_get_categories and esa_get_top_categories, which an agent will have to compare on its own.

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?

The description lists usage scenarios ("organization, cleanup, migration planning, or finding similar categories"), which implies when to reach for it. But it gives no explicit when-not conditions and never names the sibling tools (esa_get_categories, esa_get_top_categories) that an agent should weigh against it.

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