Skip to main content
Glama
Arun-kc

schemabrain

list_joins

Read-onlyIdempotent

List canonical joins between entity pairs, returning connections and provenance to understand how entities are related.

Instructions

Use this when the user asks what canonical joins are defined (e.g. 'how are these entities connected?'). Returns each confirmed join with the entity pair it connects and provenance. Use resolve_join instead when you have a known pair and want the SQL skeleton (pass name= for 2+ joins on the pair). Use suggest_joins instead when only physical-table names are available.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusYes
dataNo
errorNo
confidenceNo
provenanceNo
follow_up_hintsNo
degradation_reasonNo
charter_versionNo1.2
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint, idempotentHint, and openWorldHint. The description adds that the tool returns 'each confirmed join with the entity pair it connects and provenance.' No contradictions. Could mention scope (all joins across workspace) but not necessary.

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 with no waste. First sentence states purpose and trigger, second and third provide clear alternatives. Front-loaded structure.

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?

The tool has no parameters, comprehensive annotations, and an output schema (not shown but exists). The description covers what it does, when to use, what it returns, and distinguishes from siblings. Complete for a list tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There are no parameters, and the schema coverage is 100%. Baseline for 0 parameters is 4. The description adds no parameter info, which is acceptable.

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 ('list'), resource ('canonical joins'), and scope. It clearly distinguishes from sibling tools by explicitly naming `resolve_join` and `suggest_joins` with their appropriate use cases.

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?

The description provides explicit guidance on when to use this tool ('when the user asks what canonical joins are defined') and when to use alternatives (e.g., `resolve_join` for known pairs, `suggest_joins` for physical-table names only).

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Arun-kc/schemabrain'

If you have feedback or need assistance with the MCP directory API, please join our Discord server