Skip to main content
Glama
Scalekit MCP Server

Scalekit MCP Server

Official

create_environment_role

Create a unique role inside a Scalekit environment, setting display name, description, and default assignment. Confirm existing roles first; this does not create permission scopes.

Instructions

Create one role in an environment. Use list_environment_roles to see roles that already exist. This tool does not create a permission scope. Use create_environment_scope for that. Requires the caller OAuth token. A duplicate role name is rejected.

Input Schema

NameRequiredDescriptionDefault
roleNameYesRole name stored on the environment. Must be unique in that environment.
isDefaultNoWhen true, new organization users get this role unless another role is chosen. Default false.
descriptionNoHuman-readable explanation of the role. Empty when omitted.
environmentIdYesScalekit environment id. Format: env_<id>.
roleDisplayNameYesName shown for this role in the Scalekit dashboard.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv1.0.1
    • addedInput schema / properties / description / description
      Added value: +"Human-readable explanation of the role. Empty when omitted."
    • addedInput schema / properties / environmentId / description
      Added value: +"Scalekit environment id. Format: env_<id>."
    • addedInput schema / properties / isDefault / description
      Added value: +"When true, new organization users get this role unless another role is chosen. Default false."
    • addedInput schema / properties / roleDisplayName / description
      Added value: +"Name shown for this role in the Scalekit dashboard."
    • addedInput schema / properties / roleName / description
      Added value: +"Role name stored on the environment. Must be unique in that environment."
  2. First observedv1.0.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=false, so the mutation profile is covered. The description adds genuinely new behavioral context beyond the annotations: the caller OAuth token requirement and the duplicate-name rejection rule, though it says nothing about response contents or side effects on default role assignment.

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?

Four short sentences, each carrying a distinct decision-relevant fact: what it makes, where to look first, what it explicitly does not do, and the auth/prerequisite constraint. The core purpose leads and nothing is padded.

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?

For a 5-parameter mutation tool with no output schema, the description covers purpose, alternatives, auth requirement, and the duplicate-name failure mode, which is nearly everything an agent needs. The only minor gap is that it does not hint at what the call returns (e.g., the created role identifier), which an agent invoking this blind might want.

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 coverage is 100%, so every parameter (roleName, roleDisplayName, environmentId, isDefault, description) is already documented in the schema, including uniqueness and format constraints. The description adds no syntax or format detail beyond that, so the baseline 3 is appropriate.

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?

States a specific verb and resource ('Create one role in an environment') and immediately scopes it against lookalikes by naming create_environment_scope as the tool for permission scopes. An agent can distinguish it from both list_environment_roles and create_environment_scope without opening any schema.

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?

Gives explicit routing: use list_environment_roles to see existing roles, use create_environment_scope if a permission scope is needed rather than a role. It also flags an edge condition (duplicate role name rejected) that affects when the call will succeed.

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