Discover and Inspect
Read-only lookups across the full resource hierarchy. These are almost always the first tools called in a session - they let the AI client and the user get oriented before doing anything else. None of these tools changes your project.
Version 1.2.0: consolidated tools
Version 1.2.0 consolidates all list and describe tools in this group into two parameterized tools. For the full mapping of old tool names to new calls, see the tables below.
listREADLists entities of a given kind, scoped to an optional parent. Names are case-insensitive.
Key parameters:
kind* - one ofproject,api,suite,case,step,assertion,environment,authProfile.ref- parent scope. Omit to list all projects. Include ancestor identifiers for nested resources.
Try asking your AI client: "List all my ReadyAPI projects." "List the test suites in the Billing project."
describeREADReturns full details for a single entity. Names are case-insensitive. Errors:
NOT_FOUND,CLOSED, orNo <entity> named <name>.Key parameters:
kind* - one ofproject,api,suite,case,step,assertion,authProfile,environment,resource,method,request.ref* - path to the target entity. Include enough identifiers to resolve it uniquely within its parent chain.
Try asking your AI client: "Show me details for the Billing project." "Show me all the test steps in the Guest Checkout test case."
* Required parameter.
ref examples
list
list("project")
list("api", { projectName })
list("suite", { projectName })
list("case", { projectName, testSuiteName })
list("step", { projectName, testSuiteName, testCaseName })
list("assertion", { projectName, testSuiteName, testCaseName, testStepName })
list("environment", { projectName })
list("authProfile", { projectName })
describe
describe("project", { projectName })
describe("suite", { projectName, testSuiteName })
describe("case", { projectName, testSuiteName, testCaseName })
describe("step", { projectName, testSuiteName, testCaseName, testStepName })
describe("assertion", { projectName, testSuiteName, testCaseName, testStepName, assertionType, assertionName })
describe("authProfile",{ projectName, authProfileName })
describe("environment",{ projectName, environmentName })
describe("api", { projectName, apiName })
describe("resource", { projectName, apiName, resourcePath })
describe("method", { projectName, apiName, resourcePath, httpMethod })
describe("request", { projectName, apiName, resourcePath, httpMethod, requestName })
Supersedes in version 1.2.0
The following individual tools from version 1.1.0 are replaced by list and describe.
Version 1.1.0 tool | Version 1.2.0 equivalent |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|