Skip to main content
Glama
Sign In
homestead-mcp

homestead-mcp

by Cmarl
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

homestead_install

Install document packs or shelves into an offline library and build a search index so the downloaded content becomes searchable.

Instructions

Download documents into the library and index them, so it can be searched. Use this to set a library up from nothing. Returns immediately with a job id -- the work takes minutes, so poll homestead_job until status is 'done'. The first index build also downloads a ~2 GB embedding model.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "homestead_install"
  }
}

Input Schema

NameRequiredDescriptionDefault
packNoA named pack instead of individual shelves, e.g. 'essentials'. Defaults to essentials.
indexNoBuild the search index when the download finishes.
shelvesNoShelf slugs to install (see homestead_catalog).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

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

With no annotations, the description fully carries the burden. It discloses that the tool returns immediately with a job id, that work takes minutes, and that the first index build downloads a ~2 GB embedding model – all critical operational details. This is exemplary transparency.

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: purpose is front-loaded, async behavior and polling follow, and the model download is mentioned last. Every sentence adds value.

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?

Fully adequate for a complex tool. It covers purpose, usage, async workflow, and a significant resource warning (2 GB download). It also states the return value (job id) despite no output schema. Nothing an agent needs to call it correctly 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 coverage is 100%, so parameters are already documented. The description adds a useful pointer to homestead_catalog for shelf slugs but doesn't elaborate on pack or index beyond the schema. Baseline 3 is appropriate since the schema handles parameter documentation.

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 action (download and index documents) and resource (library), and clarifies its role as the initial setup tool ('set a library up from nothing'). This distinguishes it from sibling tools like homestead_add, which likely handle incremental additions.

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?

Provides explicit guidance on when to use it (setting up a library from nothing) and how to handle the async job (poll homestead_job until done). It doesn't explicitly name alternatives like homestead_add, but the context strongly implies it's for initial bulk setup rather than ongoing additions.

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

Deploy Server

Other Tools