Skip to main content
Glama

telys_tune

Generate a tuning plan for a collection and optionally apply index/maintenance recommendations. Use dry_run to preview changes before applying.

Instructions

Produce a TuningPlan for a collection via its Tuner, and optionally apply it. Use to inspect or apply index/maintenance recommendations. Sibling: telys_build_ivf builds the IVF index directly; this tool plans and optionally applies tuning. Applying (dry_run=false) sets the default target recall + exact↔quantized crossover and IVF-builds oversized partitions (already-built ones are skipped) — instant settings plus a faiss-requiring build that grows with partition size, applied live in-process (this handler does not persist to disk) and not atomically, so a mid-apply failure can leave earlier settings in place. Verify the after-state with telys_stats. Required: collection. Optional: dry_run (plan-only vs apply; values on the parameter). Fails when the collection does not exist.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dry_runNotrue = return the plan only; false = plan + apply; omit = the tuner's default
collectionYesname of an existing collection in the active store

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.3
    • changedInput schema / properties / dry_run / description
      Previous value: -"true never applies, false always applies, omit = tuner default"New value: +"true = return the plan only; false = plan + apply; omit = the tuner's default"
  2. Changed1 schema field changedv0.1.1
    • addedInput schema / properties / collection / description
      Added value: +"name of an existing collection in the active store"
  3. First observedv0.1.0

TDQS

A4.7/5.0
Behavior5/5

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

Beyond annotations, the description discloses critical behavioral traits: dry_run controls apply vs. plan-only, applying sets default recall and crossover, IVF-builds oversized partitions, skips already-built ones, requires faiss, runs live in-process without disk persistence, and is non-atomic with possible partial application on failure. No contradiction with annotations exists.

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 dense but every sentence earns its place: purpose, sibling distinction, side effects, failure behavior, verification, and parameter requirements. It is front-loaded with the core purpose and structured so an agent can act on it immediately.

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?

Despite having no output schema, the description covers success and failure modes, mutation semantics, non-atomicity, compute implications, and how to verify results. An agent has enough context to invoke the tool correctly and anticipate consequences.

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 baseline is 3. The description repeats that collection is required and dry_run is optional, adding no new meaning about the parameters beyond what the schema already provides.

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 opens with a specific verb and resource: 'Produce a TuningPlan for a collection via its Tuner, and optionally apply it.' It also explicitly differentiates itself from telys_build_ivf, making the tool's role unambiguous.

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?

It states the tool is for inspecting or applying index/maintenance recommendations, names the sibling telys_build_ivf as the direct-build alternative, and directs the agent to verify the after-state with telys_stats. This gives clear when-to-use and when-not-to-use guidance.

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