Skip to main content
Glama

list_roles

Retrieve OpenProject roles visible to the current user, with optional field selection and paging. Use this to discover role IDs and names for permission or assignment checks.

Instructions

List OpenProject roles visible to the current user.

select fields: id, name (see server instructions for select's general semantics). limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
offsetNo
selectNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
      +}
  2. Changed1 schema field changedv0.3.7
    • addedInput schema / additionalProperties
      Added value: +false
  3. Addedv0.3.3
  4. Removedv0.3.0
  5. 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
  6. First observedv0.2.2

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It discloses that results are scoped to the current user's visibility, and it explains the limit cap and pagination behavior via next_offset. However, it does not explicitly confirm read-only status, describe error conditions, or cover other behavioral traits an agent might need.

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?

The description is three short sentences and front-loads the purpose. The follow-up lines about select and pagination are efficient, though the middle sentence is somewhat terse and relies on an external reference for select semantics.

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

Completeness4/5

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

Given no annotations, no output schema, and 0% schema description coverage, the description still covers purpose, parameter usage, and pagination mechanics well enough for an agent to invoke the tool correctly. It could be more complete by describing the return shape or default select behavior, but the essentials are present.

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 description coverage is 0%, so the description must compensate. It adds meaning for all three parameters: limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50), offset should be set to the returned next_offset for paging, and select supports at least id and name fields. It falls short of fully self-contained semantics because it defers select's general meaning to server instructions.

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 states a specific verb and resource: 'List OpenProject roles visible to the current user.' It also scopes the result set to what the current user can see, distinguishing it from sibling list tools that target other resources like types, statuses, or priorities.

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

Usage Guidelines2/5

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

The description explains how to page and select fields, but gives no explicit guidance on when to use this tool versus alternatives. There is no mention of when-not to use it or which sibling tool to prefer in different scenarios.

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