Skip to main content
Glama

Get started

get_started
Read-only

Guides new users with no sources through connecting a source and running a first pull, and can attach a sample database when no file is available.

Instructions

The first-run guide: call it when the user is new or has no sources. It says the next step (connect a source, then a first pull) and gives a query to try. use_sample=true connects a small sample database for a user with no file to hand.

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": "get_started"
  }
}

Input Schema

NameRequiredDescriptionDefault
use_sampleNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already cover the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=false), so the bar is lower. The description still adds useful behavior: what the tool returns and the fact that use_sample=true creates a small sample database. That last point is in mild tension with readOnlyHint since it appears to add a source, but it is disclosed rather than hidden, so it is not a true contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, front-loaded with the purpose and the trigger condition before the parameter detail. No filler. The parenthetical '(connect a source, then a first pull)' is a small phrasing detour but earns its place by previewing the returned guidance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description must say what comes back, and it does: the next step plus a query to try. Combined with a single optional parameter and full annotation coverage, an agent has enough to call this correctly; only the side-effect cleanup path for the sample database is unaddressed.

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?

Schema coverage is 0%, so the description carries the burden for the single parameter, and it does: use_sample=true 'connects a small sample database for a user with no file to hand' explains both the effect and the condition for setting it. It does not state the default (false) or how to undo/disconnect the sample, but the core semantics are added.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a concrete purpose: a first-run guide that tells the user the next step and supplies a query to try. It is clear what the tool returns, but the framing is slightly meta ('the first-run guide') and it never names a sibling, so differentiation rests only on the 'new user / no sources' condition.

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?

It gives an explicit use condition: 'call it when the user is new or has no sources.' That is a clear triggering context with no inference required. It does not say when not to call it or point at alternatives such as add_source or list_sources for users who already have sources.

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