Server Configuration
Describes the environment variables required to run the server.
Name | Required | Description | Default |
---|---|---|---|
APIKEY | Yes | The API key for Octomind API | |
LOG_LEVEL | No | The log level to use | info |
LOG_FILENAME | No | The file to write logs to (only for debugging). If not set, logging is disabled | |
OCTOMIND_API_URL | No | Base URL for the API endpoint to use | https://app.octomind.dev/api |
Schema
Prompts
Interactive templates invoked by user choice
Name | Description |
---|---|
Create Login Test Case | Create a login test case for the given test target. A login test case is used to verify that a user can successfully login to a system. For a login to work with this prompt you should provide the a test account in the environment you want to use for discovery |
Resources
Contextual data attached and managed by the client
Name | Description |
---|---|
No resources |
Tools
Functions exposed to the LLM to take actions
Name | Description |
---|---|
search | the search tool can be used to search the octomind documentation for a given query. The search results are returned as a list of links to the documentation. |
getTestCase | the getTestCase tool can retrieve a test case for a given test target and test case id. A test case id is unique to the test target. The test case includes a set of interactions and assertions. it is the result of a discovery or a manual creation. |
executeTests | the executeTests tool can trigger a set of tests for a given test target. The test target id is unique to the test target. The tests are executed on the provided url. The context object is used to provide information about the source of the test execution. |
getEnvironments | the getEnvironments tool can retrieve environments for a given test target. an environment represents a specific setup or deployments for a test target. It include a test account when necsesary to login, a header configuration, a discovery url and a set of variables. |
createEnvironment | the createEnvironment tool can create an environment for a given test target. an environment represents a specific setup or deployments for a test target. It include a test account when necsesary to login, a header configuration, a discovery url and a set of variables. |
updateEnvironment | the updateEnvironment tool can update an environment for a given test target. an environment represents a specific setup or deployments for a test target. It include a test account when necsesary to login, a header configuration, a discovery url and a set of variables. |
deleteEnvironment | deleteEnvironment tool can delete an environment for a given test target. The environment id is unique to the test target. The call is not reversible. an environment represents a specific setup or deployments for a test target. It include a test account when necsesary to login, a header configuration, a discovery url and a set of variables. |
getTestReports | the getTestReports tool can retrieve test reports for a given test target. Test reports are generated when set of tests are executed. The test report id is unique to the test target. |
getTestReport | the getTestReport tool can retrieve a test report for a given test target and test report id. A test report id is generated when a set of test are executed on a test target. The test report id is unique to the test target. |
discovery | the discovery tool can create a test case on a given test target with a test case description or prompt. One can either start from the predefined url for that test case or provide a new entry point url. |
getPrivateLocations | the getPrivateLocations tool can retrieve all private locations configured for that org. A private location is a server that can be used to access a test target behind a firewall or VPN. |
getTestTargets | the getTestTargets tool can retrieve all test targets or projects. Test targets represent applications or services that can be tested using Octomind. |
createTestTarget | the createTestTarget tool can create a new test target or project. A test target represents an application or service that can be tested using Octomind. |
updateTestTarget | the updateTestTarget tool can update an existing test target. A test target represents an application or service that can be tested using Octomind. |
deleteTestTarget | the deleteTestTarget tool can delete an existing test target. This operation cannot be undone. |
getVersion | Returns the current version of the Octomind MCP server |