Skip to main content
The @guildai-services/guildai~testrail package provides agents with read-only access to the TestRail API for test management data.

​
Authentication

  • Type: Basic auth (email + API key)
  • Token expiration: None — API keys are long-lived
  • Instance URL: Each TestRail instance has its own base URL

​
Setup

1

Open Credentials

Go to Credentials in Guild.
2

Connect TestRail

Click TestRail and enter your credentials.
3

Enter Base URL

Your TestRail instance URL (e.g., https://company.testrail.io).
4

Enter Email

Your TestRail account email.
5

Enter API Key

Found in TestRail under My Settings > API Keys.
No OAuth flow is required — credentials are entered directly.

​
Usage

import { testrailTools } from "@guildai-services/guildai~testrail"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that analyzes TestRail test results",
  tools: { ...testrailTools },
})
Tools are named with the testrail_ prefix — for example, get_projects becomes testrail_get_projects.

​
API endpoints

OperationMethodPath
get_projectsGET/get_projects
get_projectGET/get_project/{project_id}
get_suitesGET/get_suites/{project_id}
get_suiteGET/get_suite/{suite_id}
get_sectionsGET/get_sections/{project_id}
get_sectionGET/get_section/{section_id}
OperationMethodPath
get_casesGET/get_cases/{project_id}
get_caseGET/get_case/{case_id}
get_attachments_for_caseGET/get_attachments_for_case/{case_id}
get_attachmentGET/get_attachment/{attachment_id}
OperationMethodPath
get_runsGET/get_runs/{project_id}
get_runGET/get_run/{run_id}
get_testsGET/get_tests/{run_id}
get_testGET/get_test/{test_id}
get_resultsGET/get_results/{test_id}
get_results_for_caseGET/get_results_for_case/{run_id}/{case_id}
OperationMethodPath
get_current_userGET/get_current_user
get_usersGET/get_users

​
Webhook events

TestRail does not support webhook triggers in Guild. This integration is API-access only.

​
Limitations

  • Read-only API operations — no creating or updating test cases, runs, or results
  • No webhook or trigger support
  • Each TestRail instance requires its own credential entry