Skip to main content
Glama
crisp-plugin-mcp

crisp-plugin-mcp

by amitray007

get_helpdesk_tree_path_metadata

Retrieves complete Knowledge Base file metadata for a specified tree_path, so you can inspect article details beyond just the title.

Instructions

Returns the whole metadata of the Knowledge Base file at the specified tree_path. Use the get_helpdesk_tree_path_title tool instead if you only need the title.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "tree_path": "<tree_path>"
    },
    "name": "get_helpdesk_tree_path_metadata"
  }
}

Input Schema

NameRequiredDescriptionDefault
localeNoThe Knowledge Base locale code (eg. 'en' for English).en
sectionNoThe Knowledge Base section (for traditional articles: 'articles').articles
tree_pathYesThe file path on the Knowledge Base tree (Markdown file).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

A3.9/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It discloses that the operation is a read returning 'whole metadata' for a specific tree path, but it does not describe the metadata fields, error behavior, permissions, or size/rate considerations.

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 short sentences, front-loaded with the primary action and followed by a useful alternative. There is no redundant or filler wording.

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

Completeness3/5

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

The tool is a simple read operation with fully documented parameters, and the sibling distinction is useful. However, without an output schema, the description gives only 'whole metadata' as the return value and does not clarify what metadata is included, leaving some ambiguity about the response.

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 description coverage is 100%, so tree_path, locale, and section are already documented in the input schema. The description reinforces tree_path as the file path on the Knowledge Base tree, but adds no further meaning about locale or section beyond the schema.

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 and resource: it returns the whole metadata of a Knowledge Base file at a given tree_path. It also explicitly distinguishes this tool from get_helpdesk_tree_path_title, so an agent can choose between them without inspecting schemas.

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 gives clear routing guidance: use get_helpdesk_tree_path_title instead when only the title is needed, which implies this tool is for full metadata. It does not explicitly address the content-specific sibling tool or state exclusions such as when not to fetch metadata.

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