Skip to main content
Glama

Import Document and Crawl

import_document_and_crawl

Complete workflow: Import document/text, create test cases, generate virtual test plan for approval, then initiate AI crawl. IMPORTANT: This tool will first generate a virtual test plan that MUST be approved by the user before proceeding. You must present the plan to the user, wait for their approval, then call this tool again with the approved_virtual_test_plan parameter to proceed with the crawl.

Input Schema

NameRequiredDescriptionDefault
urlNoProject URL for AI crawl (will use project.main_url if not provided)
depthNoCrawl depth
contextNoExplain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): "Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization."
frameworkNoTest frameworkplaywright
test_typeNoType of test to generatee2e
project_idYesProject ID to import into
pages_limitNoMaximum pages to crawl
source_nameNoOptional name for the document source
test_case_idNoTest case ID to crawl from (optional - will list test cases if not provided)
text_contentYesDocument text content to import (required if not using file_url)
enable_giskard_validationNoEnable Giskard validation
approved_virtual_test_planNoApproved virtual test plan object (required for second call after user approves the plan). Include the full virtual_test_plan object from the first call response.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Beyond the annotations, it discloses the critical approval gate: the first call generates a virtual test plan, and the crawl proceeds only on a second call with approved_virtual_test_plan. This is essential behavioral context for a write/open-world tool whose annotations only state readOnly=false, openWorld=true, destructive=false.

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?

The workflow is front-loaded, and the critical approval constraint is stated clearly in about 65 words. There is some repetition around user approval between the second and third sentences, though it reinforces an important guardrail.

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?

For a 12-parameter, open-world, multi-step tool with no output schema, the description covers the crucial approval workflow and second-call requirement. It leaves some gaps around the first-call return shape and how import/test-case creation interacts with the approval step.

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 schema already documents all 12 parameters. The description adds workflow meaning for approved_virtual_test_plan and mentions document/text import, but does not enrich semantics for crawl depth, framework, test type, or other parameters.

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 names a specific multi-step workflow: import document/text, create test cases, generate a virtual test plan for approval, then initiate an AI crawl. It is clearly more than a generic import, but it does not explicitly distinguish itself from siblings like import_test_cases_from_document or start_ai_crawl.

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 clearly explains the mandatory two-call usage pattern: present the generated plan, wait for user approval, then call again with approved_virtual_test_plan. It gives no explicit alternatives or when-not guidance against related import and crawl tools.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources