Skip to main content
Glama

Open Kioku List Symbols

list_symbols
Read-onlyIdempotent

Browse or substring-filter all indexed code symbols—functions, classes, structs, traits, interfaces—with pagination. Returns symbol name, kind, file path, and line range.

Instructions

List or substring-filter all indexed code symbols (functions, classes, structs, traits, interfaces) with pagination. Returns symbol name, kind, file path, and line range for each entry. Use to browse the indexed symbol table or filter by exact substring match. Supports pagination via limit and offset. Do NOT use for fuzzy or ranked symbol search (use search_symbols), for retrieving a symbol's full definition body (use get_definition), or for comprehensive symbol context (use get_symbol_context). This is read-only and reads from the local index only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of symbols to return. Defaults to 20, capped at 100. Use with offset for pagination.
queryNoSubstring query to filter symbol names by exact match. If omitted, returns all symbols ordered by name.
offsetNoNumber of matching symbols to skip before returning results. Defaults to 0.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
valueNoWrapped non-object output, used for Markdown, TOON, or scalar responses.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.2.3
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of symbols to return. Defaults to 20, capped at 100."New value: +"Maximum number of symbols to return. Defaults to 20, capped at 100. Use with offset for pagination."
    • addedInput schema / properties / offset
      Added value: +{
      +  "description": "Number of matching symbols to skip before returning results. Defaults to 0.",
      +  "type": "integer"
      +}
    • changedInput schema / properties / query / description
      Previous value: -"Substring query to filter symbol names. If omitted, returns all symbols."New value: +"Substring query to filter symbol names by exact match. If omitted, returns all symbols ordered by name."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "description": "The MCP structuredContent object returned by this Open Kioku tool. Most tools expose their JSON fields directly; string or scalar tool outputs are wrapped as {\"value\": ...}.",
      +  "properties": {
      +    "value": {
      +      "description": "Wrapped non-object output, used for Markdown, TOON, or scalar responses."
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed2 schema fields changedv2.0.3
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of symbols to return. Defaults to 20, capped at 100."
    • changedInput schema / properties / query / description
      Previous value: -"Symbol name filter (substring match)"New value: +"Substring query to filter symbol names. If omitted, returns all symbols."
  3. First observedv2.0.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds behavioral context: 'reads from the local index only' and mentions pagination. This goes beyond annotations, warranting a 4.

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?

Two sentences plus exclusion clause, front-loaded with key information. Every sentence earns its place; no redundancy or filler. Concise yet comprehensive.

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?

Given the presence of an output schema and the tool's straightforward nature (list/filter), the description covers all necessary aspects: what is returned (symbol name, kind, file path, line range), pagination, substring filtering, and read-only nature. Complete for its purpose.

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 has 100% coverage with parameter descriptions. The description reinforces parameter usage (pagination via limit/offset, substring filtering via query) but does not add new semantics. Baseline 3 is appropriate.

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 specific verbs (list, substring-filter) and resource (indexed code symbols) and lists example types (functions, classes, structs, traits, interfaces). It clearly distinguishes itself from sibling tools like search_symbols, get_definition, and get_symbol_context.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly states when NOT to use: 'Do NOT use for fuzzy or ranked symbol search (use search_symbols), for retrieving a symbol's full definition body (use get_definition), or for comprehensive symbol context (use get_symbol_context).' This provides clear guidance for agent to select correct tool.

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