Skip to main content
Glama

list_roles

Read-onlyIdempotent

Retrieve OpenProject roles visible to the current user, with pagination and field selection for id and name.

Instructions

List OpenProject roles visible to the current user.

Input Schema

NameRequiredDescriptionDefault
limitNoPage size, capped at OPENPROJECT_MAX_PAGE_SIZE.
offsetNo1-based page number; pass the previous result's next_offset.
selectNoFields to return; a requested unset field comes back as null. Allowed: id, name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.4.4
    • addedInput schema / properties / limit / description
      Added value: +"Page size, capped at OPENPROJECT_MAX_PAGE_SIZE."
    • addedInput schema / properties / offset / description
      Added value: +"1-based page number; pass the previous result's next_offset."
    • addedInput schema / properties / select / description
      Added value: +"Fields to return; a requested unset field comes back as null. Allowed: id, name."
  2. Changed3 schema fields changedv0.4.0
    • addedInput schema / properties / limit
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Limit"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "default": 1,
      +  "title": "Offset",
      +  "type": "integer"
      +}
    • addedInput schema / properties / select
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Select"
      +}
  3. Changed1 schema field changedv0.3.7
    • addedInput schema / additionalProperties
      Added value: +false
  4. Addedv0.3.3
  5. Removedv0.3.0
  6. Changed1 schema field changedv0.2.3
    • changedOutput schema / (root)
      Previous value: -{
      -  "$defs": {
      -    "RoleSummary": {
      -      "properties": {
      -        "id": {
      -          "title": "Id",
      -          "type": "integer"
      -        },
      -        "name": {
      -          "title": "Name",
      -          "type": "string"
      -        },
      -        "url": {
      -          "title": "Url",
      -          "type": "string"
      -        }
      -      },
      -      "required": [
      -        "id",
      -        "name",
      -        "url"
      -      ],
      -      "title": "RoleSummary",
      -      "type": "object"
      -    }
      -  },
      -  "properties": {
      -    "count": {
      -      "title": "Count",
      -      "type": "integer"
      -    },
      -    "results": {
      -      "items": {
      -        "$ref": "#/$defs/RoleSummary"
      -      },
      -      "title": "Results",
      -      "type": "array"
      -    }
      -  },
      -  "required": [
      -    "count",
      -    "results"
      -  ],
      -  "title": "RoleListResult",
      -  "type": "object"
      -}New value: +null
  7. First observedv0.2.2

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so safety is covered. The description adds only the permission-scoping note; it says nothing about pagination behavior, result ordering, or what a role record contains, leaving gaps that don't matter much for a trivial read.

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

Conciseness4/5

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

One short, front-loaded sentence with zero waste. It is efficient, though minimal enough that it borders on under-specified rather than maximally informative.

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

Completeness3/5

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

For a simple read-only list with fully documented pagination params and no output schema, the description is minimally sufficient, but it never hints at the shape of returned roles or whether pagination continuation is needed, which an agent must discover from the schema.

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

Parameters3/5

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

Schema description coverage is 100% — limit, offset, and select are all documented inline, including the 1-based offset and allowed select fields. The description adds nothing beyond that, so baseline 3 applies.

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

Purpose4/5

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

States a specific verb and resource (list roles) and adds the scoping qualifier 'visible to the current user'. It is distinguishable from nearby lookup siblings like list_capabilities or list_actions, though it doesn't explicitly name what separates it from those.

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

Usage Guidelines3/5

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

The 'visible to the current user' phrasing implies the access scope but gives no explicit when-to-use, prerequisites, or alternative tool. An agent must infer that this is the lookup to call before assigning or filtering by role.

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

Deploy Server

Other Tools