Skip to main content
Glama

list_journals

List journals accessible with current credentials and get each journal's path and name. Use the path to identify the journal in other operations.

Instructions

List the journals visible to the current credentials.

Returns a list of {"path", "name"} objects. path is the value to pass as the journal parameter in the other tools.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.2.0

TDQS

A4.3/5.0
Behavior3/5

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

No annotations are given, so the description carries the full burden. It communicates a read-only intent with 'List', gives the output shape, and defines the value of 'path' to other tools. However, it says nothing about empty results, pagination, or errors, and the 'visible to current credentials' phrase is still generic. This is adequate, but not especially transparent.

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 exactly two sentences. It front-loads the action and scope, then gives a concise output contract, and a useful pointer to sibling tools. There is no fluff or repetition.

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 zero-parameter, simple list operation, the description is complete. It explains the output and the direct use of 'path' in related tools, and because there is no output schema these details are essential. Nothing needed for the agent to call it successfully is missing.

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 the baseline for this dimension is 4. The description adds relevant cross-information by telling the agent that the returned 'path' should be used as the 'journal' param elsewhere, which is useful and denies any additional semantics.

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 states a specific verb 'List' and a clear resource, 'journals', and scopes it with 'visible to the current credentials'. This differentiates it from sibling tools such as list_issues or list_sections, and it also explains that the returned 'path' is meant for other journal-based tools, removing all ambiguity about what the tool returns.

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?

It implicitly tells the agent when to use this tool by explaining that the returned 'path' is the value to pass as the 'journal' parameter in the other tools. This is clear context for the common workflow, though it does not explicitly name or exclude alternatives.

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