Skip to main content
View Markdown ↗

Copy this page

Select and copy the Markdown below, then paste it into your LLM.

On this page

Connector tool reference

This page lists the MCP tools each connector on this branch registers, as the connector itself reports them over tools/list with writes enabled. It is generated by docs/tools/generate.ts, which builds and runs every connector under testifysec/connectors/, so it cannot drift from the code. Each tool is labelled from its MCP readOnlyHint annotation: Read when the hint is true, Write when it is false. The shared connector library registers a Write tool only when the connector runs with --enable-writes.

The Jira, Confluence and GitLab connectors are on main; example is the reference connector for authors. A managed Badger session cannot load a connector yet; see connectors.

confluence

confluence_create_page

Write. Create a page in a space (key), optionally under parent_id. body is markdown: headings, paragraphs, lists, fenced code, bold, inline code and http(s) links. Changes the service. Every result carries the connector's configured classification marking.

ParameterTypeRequiredDescription
bodystringyes
parent_idstringno
spacestringyes
titlestringyes

confluence_get_page

Read. Get a page as markdown with its labels, version and ancestor ids. Pass id, or space (key) and exact title. Every result carries the connector's configured classification marking.

ParameterTypeRequiredDescription
idstringno
spacestringno
titlestringno

confluence_list_children

Read. List the child pages of a page id. limit 1-50 (default 25), start to page. Every result carries the connector's configured classification marking.

ParameterTypeRequiredDescription
idstringyes
limitintegerno
startintegerno

confluence_list_spaces

Read. List spaces you can see. limit 1-50 (default 25), start to page, type global or personal. Every result carries the connector's configured classification marking.

ParameterTypeRequiredDescription
limitintegerno
startintegerno
typestringno

Read. Search content with CQL (e.g. space = ENG and type = page and text ~ "release"). limit 1-50 (default 10); page with start, or cursor when the result says so. Returns ids, titles and spaces. Every result carries the connector's configured classification marking.

ParameterTypeRequiredDescription
cqlstringyes
cursorstringno
limitintegerno
startintegerno

confluence_update_page

Write. Replace a page body (markdown, as for create) and optionally its title. version must be the page's current version number from confluence_get_page; the update is refused if the page has changed since. Changes the service. Every result carries the connector's configured classification marking.

ParameterTypeRequiredDescription
bodystringyes
idstringyes
titlestringno
versionintegeryes

example

Reference connector for authors; not shipped.

example_add_note

Write. Add a note to an item. Changes the service.

ParameterTypeRequiredDescription
idintegeryes
textstringyes

example_get_item

Read. Get one item by numeric id: title, state, author and body.

ParameterTypeRequiredDescription
idintegeryes

gitlab

gitlab_add_note

Write. Add a comment to an issue or merge request. Changes the service.

ParameterTypeRequiredDescription
bodystringyesmarkdown comment
iidintegeryesthe project-scoped number shown as #N or !N
projectstringyesnumeric project id or full path, e.g. group/subgroup/project
targetstringyesissue or merge_request

gitlab_create_issue

Write. Create an issue in a project. Changes the service.

ParameterTypeRequiredDescription
descriptionstringnomarkdown body
labelsarray of stringnolabels to set
projectstringyesnumeric project id or full path, e.g. group/subgroup/project
titlestringyesissue title

gitlab_get_file

Read. Get a text file from the repository at a branch, tag or commit. Binary files are refused, and a path containing ";" cannot be read. The result's classification banner is the connector's configured marking.

ParameterTypeRequiredDescription
pathstringyesfile path inside the repository, e.g. cmd/app/main.go
projectstringyesnumeric project id or full path, e.g. group/subgroup/project
refstringnobranch, tag or commit; default the project's default branch

gitlab_get_issue

Read. Get one issue with its description and the first discussion threads (system notes left out). The result's classification banner is the connector's configured marking.

ParameterTypeRequiredDescription
iidintegeryesthe project-scoped number shown as #N or !N
notesintegernohow many discussion threads to include, 0-100, default 20; 0 leaves them out
projectstringyesnumeric project id or full path, e.g. group/subgroup/project

gitlab_get_job_log

Read. Get the last lines of a CI job's log, with terminal escapes removed. The result's classification banner is the connector's configured marking.

ParameterTypeRequiredDescription
job_idintegeryesjob id from gitlab_list_pipelines
projectstringyesnumeric project id or full path, e.g. group/subgroup/project
tail_linesintegernolines from the end, 1-2000, default 200

gitlab_get_merge_request

Read. Get one merge request with its description and discussion threads, including the file and line of review comments. The result's classification banner is the connector's configured marking.

ParameterTypeRequiredDescription
iidintegeryesthe project-scoped number shown as #N or !N
notesintegernohow many discussion threads to include, 0-100, default 20; 0 leaves them out
projectstringyesnumeric project id or full path, e.g. group/subgroup/project

gitlab_get_merge_request_diff

Read. Get a merge request's changed files and diffs, capped per file and per call. Paged by file. The result's classification banner is the connector's configured marking.

ParameterTypeRequiredDescription
iidintegeryesthe project-scoped number shown as #N or !N
pageintegernopage number, default 1
per_pageintegernoitems per page, 1-100, default 20
projectstringyesnumeric project id or full path, e.g. group/subgroup/project

gitlab_get_project

Read. Get a project: path, default branch, visibility, topics, description. The result's classification banner is the connector's configured marking.

ParameterTypeRequiredDescription
projectstringyesnumeric project id or full path, e.g. group/subgroup/project

gitlab_list_merge_requests

Read. List a project's merge requests, newest first. Paged. The result's classification banner is the connector's configured marking.

ParameterTypeRequiredDescription
labelsstringnocomma-separated labels
pageintegernopage number, default 1
per_pageintegernoitems per page, 1-100, default 20
projectstringyesnumeric project id or full path, e.g. group/subgroup/project
searchstringnotext to find in title and description
source_branchstringnosource branch
statestringnoopened, closed, merged, locked or all
target_branchstringnotarget branch

gitlab_list_pipelines

Read. List a project's pipelines, newest first, or with pipeline_id the jobs of one pipeline (job ids feed gitlab_get_job_log).

ParameterTypeRequiredDescription
pageintegernopage number, default 1
per_pageintegernoitems per page, 1-100, default 20
pipeline_idintegernolist this pipeline's jobs instead
projectstringyesnumeric project id or full path, e.g. group/subgroup/project
refstringnobranch or tag
statusstringnopipeline status, e.g. failed, success, running

gitlab_search_issues

Read. List or search a project's issues, newest first. Paged. The result's classification banner is the connector's configured marking.

ParameterTypeRequiredDescription
labelsstringnocomma-separated labels, all must match
pageintegernopage number, default 1
per_pageintegernoitems per page, 1-100, default 20
projectstringyesnumeric project id or full path, e.g. group/subgroup/project
searchstringnotext to find in title and description
statestringnoopened, closed or all

jira

jira_add_comment

Write. Add a comment (Jira wiki markup) to an issue. Changes the service.

ParameterTypeRequiredDescription
keystringyes
bodystringyes

jira_create_issue

Write. Create an issue in a project. Changes the service.

ParameterTypeRequiredDescription
projectstringyesproject key, e.g. PROJ
issue_typestringyesissue type name, e.g. Task
summarystringyes
descriptionstringnoJira wiki markup

jira_get_issue

Read. Get one issue by key (PROJ-123): summary, status, type, priority, assignee, reporter, labels, components, description as markdown, and linked issues.

ParameterTypeRequiredDescription
keystringyesissue key, e.g. PROJ-123

jira_list_comments

Read. List an issue's comments, oldest first, one page at a time (default 20, at most 50).

ParameterTypeRequiredDescription
keystringyes
start_atinteger (minimum 0)no
max_resultsinteger (minimum 1, maximum 50)no

Read. Search issues with JQL. Returns one page (default 20, at most 50) of key, status, summary, type, priority, assignee and updated date; pass start_at from the previous page's next_page to continue. fields adds or replaces the returned fields (Jira field ids).

ParameterTypeRequiredDescription
jqlstringyesJQL query
start_atinteger (minimum 0)no
max_resultsinteger (minimum 1, maximum 50)no
fieldsarray of string (at most 20)no

jira_transition_issue

Write. Move an issue through its workflow by transition name or id. If the transition is not available, the error lists the ones that are. Changes the service.

ParameterTypeRequiredDescription
keystringyes
transitionstringyestransition name or id

Reference generated from the product documentation. Match commands and support details to your installed release.