Skip to main content
Glama
Sign In
YNAB MCP Server

YNAB MCP Server

by oliverames
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

Search Categories

search_categories
Read-onlyIdempotent

Search YNAB category and category group names by case-insensitive multi-word tokens, ranked by phrase and name matches, to locate budget categories when exact names are unknown.

Instructions

Search category/group names with case-insensitive OR tokens, ranked by phrase/name hits. Returns matched_on/terms. No synonyms; fall back to list_categories.

Input Schema

NameRequiredDescriptionDefault
queryYesCategory/group name; multi-word queries OR-match each word.
budgetIdNo
includeHiddenNoIf true, also search hidden categories and hidden category groups (default false).

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv6.1.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / properties / budgetId / description
      Removed value: -"Budget ID (uses default if not provided)"
    • changedInput schema / properties / query / description
      Previous value: -"Category or group name to search for. Multi-word queries are OR-matched per word (e.g. 'work expenses' matches '💻 Work Expenses (Oliver LLC)' and anything in a 'Business Expenses' group)."New value: +"Category/group name; multi-word queries OR-match each word."
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Changed1 schema field changedv5.4.0
    • removedOutput schema / properties / result / description
      Removed value: -"Structured result returned by Search Categories."
  3. Changed2 schema fields changedv5.2.0
    • addedInput schema / properties / includeHidden
      Added value: +{
+  "description": "If true, also search hidden categories and hidden category groups (default false).",
+  "type": "boolean"
+}
    • changedInput schema / properties / query / description
      Previous value: -"Partial category name to search for (e.g. 'work' matches '💻 Work Expenses (Oliver LLC)')"New value: +"Category or group name to search for. Multi-word queries are OR-matched per word (e.g. 'work expenses' matches '💻 Work Expenses (Oliver LLC)' and anything in a 'Business Expenses' group)."
  4. Changed1 schema field changedv5.1.1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "properties": {
+    "result": {
+      "description": "Structured result returned by Search Categories."
+    }
+  },
+  "required": [
+    "result"
+  ],
+  "type": "object"
+}
  5. First observedv2.0.0

TDQS

A4.2/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-only, idempotent operation, and the description adds genuine behavioral context beyond that: OR-token matching, ranking by phrase/name hits, and the explicit limitation that synonyms are not expanded. It also names the returned fields (matched_on/terms).

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?

Three tight sentences with no waste; matching behavior and the fallback guidance are front-loaded for quick scanning.

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 an output schema present, the description needn't explain return values, and annotations carry the safety profile; what remains missing is any explanation of the budgetId parameter for a multi-budget context.

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 67%: query and includeHidden are documented in the schema, and the description's OR-token note largely restates the query field description. budgetId is undocumented in both schema and description, leaving a real gap that the description does not compensate for.

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+resource (search category/group names) plus the matching semantics (case-insensitive OR tokens, phrase/name ranked hits), which is far more precise than the sibling list_categories.

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?

Explicitly names the fallback alternative (list_categories) and the condition that triggers it (no synonym support). It doesn't address when to prefer this over suggest_transaction_categories or other search tools, but the key routing decision is covered.

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

Deploy Server

Other Tools