Skip to main content
Glama

check_homedata_api_key

Verify your Homedata API key is set and working before using data tools. Diagnose authorization or quota errors by checking key validity.

Instructions

Check whether the user's HOMEDATA_API_KEY is set + working.

Use this:

  • before recommending Homedata data tools, to know if they're available

  • after the user runs start_homedata_signup, to confirm they've completed verification + set the env var (after MCP server restart)

  • if a data tool returned an unauthorised / quota error, to diagnose

Returns a structured status the AI agent can reason about. NO API key material is returned — only a 6-character prefix for diagnostic purposes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

Despite no annotations, the description fully discloses behavior: returns a structured status, no API key material is returned except a 6-character prefix for diagnostics. This transparency is sufficient for the tool's simple nature.

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?

The description is concise with a clear bullet-like structure, front-loading the action and then listing use cases. Every sentence adds value without fluff.

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?

For a zero-parameter diagnostic tool with an output schema, the description covers the purpose, usage scenarios, and return value characteristics comprehensively. No gaps remain.

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

Parameters5/5

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

The tool has zero parameters, so the input schema provides full coverage. The description adds value by explaining the purpose and output, which is more than adequate for a parameterless tool.

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 clearly states that the tool checks whether the HOMEDATA_API_KEY is set and working. It uses a specific verb ('check') and resource ('API key'), and differentiates itself from sibling data tools by being a diagnostic/prerequisite check.

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 use cases: before recommending Homedata tools, after signup to confirm, and for error diagnosis. This clearly guides when to use this tool versus alternatives like starting signup or using data tools.

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/wehomemove/homedata-mcp'

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