Skip to main content
Glama

search_artifacts

Read-onlyIdempotent

Search artifact file contents across a repo using substring or regex queries, with optional glob and repo filters to locate code or settings in JavaScript, JSON, HTML, CSS, and Markdown files.

Instructions

Search artifact file CONTENT across a repo (grep). Substring by default, or a regex. Defaults to webApps/services/settings .js/.json/.html/.css/.md files; narrow with glob.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
globNoLimit to files matching this glob, e.g. 'webApps/*/flows/**/*.js'
repoNoRepo checkout to target: absolute path, or a repo name under VBS_WORKSPACE_DIR, or omit to use VBCS_REPO_PATH default. Use list_repos to see what's available on this instance.
queryYesText (or regex when regex=true) to find
regexNo
ignoreCaseNo
maxResultsNoDefault 200, max 2000

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.3.2

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint/destructiveHint, so safety is covered. The description adds genuinely useful behavioral context beyond that: the default search scope (which file types the default covers) and the substring-vs-regex default mode. It stops short of describing return format or result ordering.

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 tight sentences, front-loaded with the core action and mechanism. Every clause earns its place: purpose, matching mode default, and default scope. No filler.

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

Completeness3/5

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

For a dense search tool with no output schema, the description covers purpose, default scope, and matching mode but says nothing about the shape of results or how maxResults/pagination behaves in practice. It is minimally complete but leaves the agent guessing what a result looks like.

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 67%, and the description meaningfully supplements it: it defines the default matching mode for 'query', names 'glob' as the narrowing mechanism, and notes regex activation. This is more than mere restatement, though ignoreCase/maxResults/repo semantics remain only in the schema.

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 verb (Search), the exact resource (artifact file CONTENT), and the mechanism (grep). The word 'CONTENT' and '(grep)' cleanly distinguish it from siblings like read_artifact, list_artifacts, and list_repos, which operate on file presence/listing rather than content.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explains the default behavior ('Defaults to webApps/services/settings .js/... files') and how to narrow results ('narrow with glob'), which implies when it's useful. However, it never states when to reach for this over read_artifact or list_artifacts, nor any exclusions, so usage is inferred rather than guided.

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