Skip to main content
Glama

Farm.js Docs

Get docs config schema

get_config_schema
Read-only

Return structured docs.config.ts option metadata, optionally filtered by option path or query.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNo
optionNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
filtersNo
optionsYes
examplesYes
configFileYes
descriptionYes
resultCountYes
schemaVersionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

readOnlyHint=true already establishes this as a safe read, and the description's 'Return structured ... metadata' is consistent with that. It adds that filtering is optional, but says nothing about output shape beyond what the output schema provides, so with annotations carrying the safety signal a 3 is appropriate.

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?

A single front-loaded sentence with no waste: verb and resource come first, and the optional filtering clause is properly subordinated at the end.

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?

The tool is low-complexity: read-only, two optional params, and an output schema that already documents the return structure. Purpose and filtering are covered, so no return-value documentation is needed; only filter semantics remain thin, which keeps it from a 5.

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 0%, so the description must compensate, and it partially does by naming both filter modes ('option path' and 'query'). However it never explains the expected format of an option path, what 'query' matches against, or whether the two filters combine, leaving real ambiguity for two undocumented parameters.

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?

The description states a specific verb ('Return') and a specific resource ('docs.config.ts option metadata'), which is clearly distinct from the docs-content siblings like get_context and get_navigation. It stops short of explicitly positioning itself relative to those adjacent getters, so it lands just under a 5.

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

Usage Guidelines2/5

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

The only guidance is about optional filtering ('optionally filtered by option path or query'), which is parameter behavior, not when-to-use guidance. There is no statement of when an agent should reach for this tool versus get_context or get_navigation, and no prerequisites or exclusions.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.