FoxNose Knowledge

describe_resource

Read-onlyIdempotent

Return schema and searchability for a resource_id. Call it before filtering or sorting, to learn the field names and which fields are searchable. Searching by text does not need it.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`parents`	No	Parent placeholders for nested resource_id templates.
`resource_id`	Yes	Resource identifier from discover_resources.

Output Schema

TableJSON Schema

Name	Required	Description
`name`	No
`path`	No
`alias`	No
`actions`	No
`schema_key`	No
`description`	No
`json_schema`	Yes	JSON Schema of the record body. Reference fields appear as plain strings; nothing here marks them as references.
`resource_id`	Yes
`content_type`	No
`required_parents`	No
`searchable_fields`	No
`schema_version_key`	No
`non_searchable_fields`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedSep 21, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "actions": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "alias": {
+      "type": "string"
+    },
+    "content_type": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "json_schema": {
+      "additionalProperties": true,
+      "description": "JSON Schema of the record body. Reference fields appear as plain strings; nothing here marks them as references.",
+      "type": "object"
+    },
+    "name": {
+      "type": "string"
+    },
+    "non_searchable_fields": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "path": {
+      "type": "string"
+    },
+    "required_parents": {
+      "items": {
+        "additionalProperties": true,
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "resource_id": {
+      "type": "string"
+    },
+    "schema_key": {
+      "type": "string"
+    },
+    "schema_version_key": {
+      "type": "string"
+    },
+    "searchable_fields": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "json_schema",
+    "resource_id"
+  ],
+  "type": "object"
+}

First observedSep 17, 2026

TDQS

A4.3/5.0

Behavior3/5

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

Annotations already carry the safety profile (readOnlyHint=true, idempotentHint=true, destructiveHint=false), so the description only needs to add context. It discloses that the tool returns schema and searchability info, consistent with a read-only introspection tool, but adds no further behavioral detail such as error behavior or performance characteristics.

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 sentences, zero filler: the purpose is front-loaded, followed by when to call and when not to. Every sentence earns its place.

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?

Output schema exists so return values need no explanation; annotations carry the safety profile; and the description covers purpose, timing, and counter-indications. For a low-complexity, single-required-parameter introspection tool, nothing an agent needs is missing.

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 the schema already documents both parameters, including that resource_id comes from discover_resources. The description adds no parameter-level detail beyond what the schema provides, so the baseline of 3 applies.

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 and resource ('Return schema and searchability for a resource_id'), clearly positioning it as a metadata-introspection tool. This differentiates it from the CRUD and search siblings (get_record, search_records, query_records) without needing to inspect any schema.

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?

Gives explicit when-to-use guidance ('Call it before filtering or sorting') and an explicit when-not-to-use exclusion ('Searching by text does not need it'). While it doesn't name a sibling tool, the instructions are concrete, actionable, and leave nothing to inference.

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

All FoxNose Knowledge tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?