Skip to main content
Glama

Check Roblox APIs for deprecation

check_api_health
Read-only

Verify Roblox APIs before writing Luau: check existence, casing, deprecation, security level, and yield behavior of classes, members, and enums.

Instructions

Batch-check Roblox APIs before you ship Luau that uses them. Pass entries like "Humanoid.MoveTo", "BodyVelocity", "Enum.Material.Neon", "task.wait" or "wait" and each is verified against the live API dump and the official docs: does it still exist, is it spelled with the right case, is it deprecated (with the official replacement where the docs give one), is it locked behind a security level normal scripts cannot use, and does it yield. Use this whenever you are about to write or review Roblox code — models often reproduce APIs that Roblox retired years ago.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
membersYesEntries to check: "ClassName", "ClassName.MemberName", or an expression copied from code, e.g. ["BodyVelocity", "Humanoid.MoveTo", "game.Players.LocalPlayer.Character", "Instance.new(\"Part\").Anchored"].
max_tokensNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.3.1
    • changedInput schema / properties / members / description
      Previous value: -"Entries to check: \"ClassName\" or \"ClassName.MemberName\", e.g. [\"BodyVelocity\", \"Humanoid.MoveTo\"]."New value: +"Entries to check: \"ClassName\", \"ClassName.MemberName\", or an expression copied from code, e.g. [\"BodyVelocity\", \"Humanoid.MoveTo\", \"game.Players.LocalPlayer.Character\", \"Instance.new(\\\"Part\\\").Anchored\"]."
  2. First observedv1.0.2

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly/openWorld/non-destructive, so the bar is lower, and the description still adds real substance: the five checks performed (existence, casing, deprecation with replacement, security level, yielding) plus the source of truth. It doesn't describe response formatting or how results are ordered, keeping it at a 4.

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?

Front-loaded with the core action and two sentences total, so it is efficient. The second sentence is a long enumerated clause, but each item adds a distinct verification dimension rather than padding.

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 two-parameter check tool with no output schema, the description enumerates what is verified and where the data comes from, which effectively substitutes for a return-value spec. It leaves the `max_tokens` parameter and any batching/pagination nuance unaddressed, so it is strong but not fully complete.

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 50%. The description reinforces the `members` entry format with concrete examples ("Humanoid.MoveTo", "task.wait") that mostly echo the schema's own description, while the second parameter, `max_tokens`, gets no mention at all. Adequate but not fully compensating for the coverage gap.

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: batch-checks Roblox APIs against the live API dump and official docs. It clearly distinguishes itself from siblings like get_engine_api (lookup) and search_creator_docs (search) by being a validation/deprecation check, so an agent can route correctly without opening other schemas.

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

Usage Guidelines4/5

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

Explicitly tells the agent when to reach for it: 'whenever you are about to write or review Roblox code,' motivated by models reproducing retired APIs. Strong context, but it never names an alternative (e.g. get_engine_api) or states when not to use it, so it stops short of the 5 benchmark.

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