Skip to main content
Glama
Scalekit MCP Server

Scalekit MCP Server

Official

register_mcp_server

Register an MCP server in a Scalekit environment and return its OAuth protected-resource metadata; the server URL becomes the token audience.

Instructions

Register one MCP server in an environment and return its protected-resource metadata. Use list_mcp_servers to see servers that already exist. Use update_mcp_server to change a server after it exists. Requires the caller OAuth token. Publish that metadata at /.well-known/oauth-protected-resource on the server. The URL you pass becomes the token audience.

Input Schema

NameRequiredDescriptionDefault
nameYesDisplay name of the MCP server.
providerNoConnection key id for a customer-owned provider. Leave empty when useScalekitAuthentication is true.
descriptionNoShort explanation of what this MCP server does. Empty when omitted.
mcpServerUrlYesPublic URL of the MCP server. This URL becomes the token audience.
environmentIdYesScalekit environment id. Format: env_<id>.
accessTokenExpiryYesAccess token lifetime in seconds.
useScalekitAuthenticationYesTrue uses Scalekit authentication. False requires a provider key id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv1.0.1
    • addedInput schema / properties / accessTokenExpiry / description
      Added value: +"Access token lifetime in seconds."
    • addedInput schema / properties / description / description
      Added value: +"Short explanation of what this MCP server does. Empty when omitted."
    • addedInput schema / properties / environmentId / description
      Added value: +"Scalekit environment id. Format: env_<id>."
    • addedInput schema / properties / mcpServerUrl / description
      Added value: +"Public URL of the MCP server. This URL becomes the token audience."
    • addedInput schema / properties / name / description
      Added value: +"Display name of the MCP server."
    • addedInput schema / properties / provider / description
      Added value: +"Connection key id for a customer-owned provider. Leave empty when useScalekitAuthentication is true."
    • addedInput schema / properties / useScalekitAuthentication / description
      Added value: +"True uses Scalekit authentication. False requires a provider key id."
  2. First observedv1.0.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare non-read-only, non-idempotent, non-destructive, closed-world behavior. The description adds genuinely new context: an OAuth token is required, the returned metadata must be published at /.well-known/oauth-protected-resource, and the passed URL becomes the token audience.

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?

Five short sentences, each carrying distinct information (purpose, alternatives, auth requirement, publish instruction, audience semantics). Front-loaded with the core action and free of filler.

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 7-parameter mutation tool with no output schema, the description covers the action, prerequisites, alternatives, and the meaning of the returned metadata. It does not detail the structure of the returned protected-resource metadata, but the operational guidance is otherwise complete.

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%, so the baseline is 3. The description goes further by explaining the cross-cutting consequence of mcpServerUrl — it becomes the token audience — which the schema states but reinforces operationally, and it clarifies the auth-token prerequisite for the call.

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 — 'Register one MCP server in an environment' — and the side effect of returning protected-resource metadata. It is unmistakably distinct from list_mcp_servers and update_mcp_server, which are named directly.

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 routes the agent: use list_mcp_servers to view existing servers and update_mcp_server to modify an existing one. The 'one server' scope and the create-then-modify boundary leave nothing to inference.

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