Skip to main content
Glama

testneo_api_project_openapi_impact

Analyze how API test cases are affected by a new or stored OpenAPI specification. Detect test failures and flag impacted tests using impact analysis.

Instructions

Run OpenAPI impact analysis for API (non-web) test cases against a new or stored spec. Pass openapi_spec to diff an inline revision, or omit to analyze using the spec already saved on the project. Guarded: allow-write + confirm=true (service may flag tests). Backend: POST /api/v1/projects/{id}/openapi-impact.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYes
openapi_specNo
auto_flagNo
business_rulesNo
confirmNo
idempotency_keyNo
Behavior3/5

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

No annotations exist, so the description carries the transparency burden. It discloses that the tool may flag tests, requires confirmation (confirm=true), and specifies the backend endpoint. However, it does not detail side effects (e.g., whether the spec is saved, how existing tests are affected, or what 'impact analysis' entails operationally).

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 concise (three sentences) and front-loaded with the core purpose. Each sentence adds essential information: the action, the parameter usage, and the guarding requirement. No redundant or extraneous content.

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

Completeness2/5

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

Given the tool's complexity (6 parameters, no output schema, no annotations), the description is insufficient. It lacks explanation of the output, the meaning of business_rules and auto_flag, and the overall workflow. The high number of parameters and the potential for internal state changes are not addressed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description must explain parameters but only elaborates on openapi_spec. It omits explanations for project_id, auto_flag, business_rules, confirm, and idempotency_key, leaving their semantics unclear despite the schema providing names and types.

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 clearly states the tool's purpose: running OpenAPI impact analysis for API (non-web) test cases against a new or stored spec. It differentiates from web-focused siblings by specifying 'API (non-web)', but does not explicitly compare with other impact analysis tools like testneo_swagger_impact_analysis.

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?

The description explains when to pass openapi_spec (to diff an inline revision) versus omit (use stored spec), and mentions the 'confirm=true' requirement for guarded operations. However, it does not provide guidance on when not to use this tool, nor does it reference alternatives among sibling tools.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/gururajhm-neo/testneo-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server