Skip to main content
Glama

codelab_read

Read public Code Lab source text by workId. Never executes, uploads, creates or edits code.

Input Schema

NameRequiredDescriptionDefault
workIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/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 and does a good job stating that it never executes, uploads, creates, or edits code. It still omits other behavioral details an agent may need, such as whether public works are restricted, what happens if the workId is invalid, or return format.

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?

Two short sentences with the core action front-loaded and the safety boundary stated immediately after. There is no wasted text, and the constraints are easy to scan.

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 one-parameter read tool with no output schema, the description covers the main action and read-only safety well. It remains incomplete for invocation because it does not clarify the workId's source or format, nor what the tool returns.

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

Parameters2/5

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

The single parameter has 0% schema description coverage, and the description does not explain what a workId is, where to obtain one, or its expected format. Mentioning 'by workId' only restates the parameter name rather than adding semantic meaning.

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?

The description states a specific verb and resource: read public Code Lab source text by workId. This is clear enough to distinguish it from codelab_list and codelab_tip, though it does not explicitly name those siblings or contrast their purposes.

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 description implies the tool is for reading a specific Code Lab work by ID, and the second sentence clarifies safety boundaries. However, it does not explicitly say when to use this instead of codelab_list, codelab_tip, or other read tools such as workshop_read and library_read.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources