Skip to main content
Glama

sonarqube_list_projects

Read-onlyIdempotent

List SonarQube projects with optional name filter. Use to discover project keys for metrics or issues retrieval.

Instructions

List SonarQube projects (components with qualifier TRK).

Use this first to discover which project keys exist before calling sonarqube_project_metrics or sonarqube_get_issues.

Pagination: if has_more is True, call again with page + 1. Results are sorted by SonarQube default order (component name ascending).

Examples: - Use when: "What SonarQube projects contain 'backend' in the name?" → query='backend', default pagination. - Use when: The user gives a project name but not its key. - Don't use when: You already have the project key and only need its metrics (call sonarqube_project_metrics directly — one fewer round trip). - Don't use when: You need Quality Gate status (that's sonarqube_quality_gate_status; this tool doesn't return it).

Returns: dict with keys projects_count / total / page / page_size / has_more / next_page / query / projects (list).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNoOptional substring to filter project keys or names (case-insensitive). Example: 'einvy' matches any project containing that substring.
pageNoPage number (1-based).
page_sizeNoItems per page (1-500).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
projects_countYes
totalYes
pageYes
page_sizeYes
has_moreYes
next_pageYes
queryYes
projectsYes
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate safe read-only operation; description adds pagination behavior (has_more, sort order), and clarifies what the tool doesn't return, exceeding annotation requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well-structured with clear sections, front-loaded with main purpose, and every sentence provides useful guidance without verbosity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the output schema existence, the description covers usage context, pagination, and examples thoroughly, leaving no significant gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%; description adds value with concrete examples for query and pagination instructions, enhancing understanding beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it lists SonarQube projects with qualifier 'TRK', and distinguishes itself from sibling tools by noting when to use it to discover project keys before calling other tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly provides when-to-use examples (e.g., discover project keys, find projects with substring) and when-not-to-use (when key is known, need quality gate status), with specific sibling tool alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mshegolev/sonarqube-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server