Skip to content

docs(ai): backfill plugin reference table with TCM tools and getOrgSettings #528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tiffany-kobiton wants to merge 1 commit into from
Closed

docs(ai): backfill plugin reference table with TCM tools and getOrgSettings #528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 70 additions & 1 deletion docs/modules/ai/pages/mcp/ai-plugin-mcp-ref.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ For the latest updates on the plugin, refer to the https://github.com/kobiton/au

== MCP tools

The plugin exposes 13 MCP tools across 4 domains.
The plugin exposes 29 MCP tools across 7 domains.

=== Devices

Expand Down Expand Up @@ -45,6 +45,9 @@ The plugin exposes 13 MCP tools across 4 domains.

|`terminateSession`
|Stop a running test session.

|`getUserInputEvents`
|Get canvas touch and swipe events captured during a live device-only session. See xref:mcp/get-user-input-events.adoc[].
|===

=== Apps
Expand Down Expand Up @@ -74,6 +77,72 @@ The plugin exposes 13 MCP tools across 4 domains.

|`getCredential`
|Return the OAuth-authenticated user's username, API key (existing or newly generated), and portal URL. Backs the `/automate:setup` command - no manual file editing required.

|`getOrgSettings`
|Return your organization's settings, including feature flags such as Live Remediation.
|===

=== Test cases

[cols="1,3",options="header"]
|===
|Tool |Description

|`saveTestCase`
|Convert a manual session into a reusable IQS test case. Rejects non-manual sessions.

|`listTestCases`
|List test cases in your organization with optional filters for app, keyword, and pagination.

|`getTestCase`
|Get a test case's details and steps. Returns the latest version by default; a specific version with `versionCode`.

|`updateTestCase`
|Edit test case metadata, step text, element-selection remediation, or version.

|`deleteTestCase`
|Delete a test case.
|===

=== Test runs

[cols="1,3",options="header"]
|===
|Tool |Description

|`createTestRun`
|Launch a test run against a test suite or specific test case versions. Fire-and-forget.

|`listTestRuns`
|List test runs in your organization with optional filters.

|`getTestRun`
|Get a test run's details, sessions, and status.

|`terminateTestRun`
|Stop an in-progress test run.
|===

=== Test suites

[cols="1,3",options="header"]
|===
|Tool |Description

|`listTestSuites`
|List test suites in your organization with optional filters for app, keyword, and pagination.

|`getTestSuite`
|Get a test suite's details, including member test cases and their pinned versions.

|`createTestSuite`
|Create a test suite from a name and a list of test case IDs.

|`updateTestSuite`
|Edit test suite metadata or membership.

|`deleteTestSuite`
|Delete a test suite. Member test cases are unaffected.
|===

== Skills
Expand Down
8 changes: 3 additions & 5 deletions docs/modules/ai/pages/workflows/monitor-test-run.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The `monitorTestRun` MCP skill watches a Kobiton test run launched from Claude.

== Before you begin

* A test run launched from Claude with the `createTestRun` MCP skill.
* A test run launched from Claude with the xref:ai:mcp/ai-plugin-mcp-ref.adoc[`createTestRun`] MCP skill.

== Watch a test run

Expand Down Expand Up @@ -60,7 +60,5 @@ image:monitor-test-run-summary.png[width=800,alt="Claude chat showing the final

* xref:test-management:remediations.adoc[Remediations]
* xref:ai:mcp/ai-plugin-mcp-ref.adoc[Kobiton AI plugin and tools reference]
// TODO: uncomment when createTestRun is documented in the plugin reference table
// * xref:ai:mcp/ai-plugin-mcp-ref.adoc[createTestRun MCP tool]
// TODO: uncomment when getOrgSettings is documented in the plugin reference table
// * xref:ai:mcp/ai-plugin-mcp-ref.adoc[getOrgSettings MCP tool]
* xref:ai:mcp/ai-plugin-mcp-ref.adoc[createTestRun MCP tool]
* xref:ai:mcp/ai-plugin-mcp-ref.adoc[getOrgSettings MCP tool]
Loading