Skip to main content
Glama

Get Workshop settings

get_workshop
Read-only

GET ONLY the 'Workshop' field of TitlePublicConfigurationModel. Workshop - the catalog of content made by PLAYERS (maps, levels, skins, models, any file the game defines) and by the publisher (official content), and the LICENSES to it. Nothing is transferred: acquiring grants a license to a digital copy, so one publication is acquired by many and the author keeps it (unlike Marketplace, which escrows and moves goods). ContentTypes is the game-specific part: each type id (e.g. 'voxelcraft.world') declares its file roles (AllowedMimeTypes, MaxBytes, MaxCount, Required; the engine checks the uploaded file's signature against the declared type), whether a thumbnail is required, which AccessModes authors may use, an optional per-type PricePolicy, a PublishGate (SegmentGate: who may publish), PublishFeeOptions (PriceOption, Standard part only, never store-paid), a TagVocabulary and per-player limits. An author gives access by ANY of several options: Free, Price (a ResourceBundle validated by PricePolicy; the buyer pays, the author receives it minus Commission, which is burned or credited to the MarketplaceLedger) or Holding (hold N of a currency/item - nothing is charged; Mode WhileHeld re-checks on every download, UnlockOnce checks once and grants a permanent license; HoldingPolicy whitelists usable resources). Moderation: BlockedTerms for titles/descriptions/tags, AutoHideReportThreshold (reports that hide a publication until reviewed), RequireApproval (pre-moderation). Featured lists publisher-curated collections with their own ScheduleSpec and SegmentGate. Publications, licenses, reactions and reports are NOT here - they are operational data in their own collections; files live in a private bucket configured by the engine's WORKSHOP_BUCKET_NAME env var.

Input Schema

NameRequiredDescriptionDefault
title_idYesTitleID, для которого читаются данные.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so the safety profile is covered. The description adds useful scope context about what is NOT returned (operational data lives in other collections) and where files reside (WORKSHOP_BUCKET_NAME private bucket). It does not describe side effects, permissions, or response shape beyond domain lore.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single key sentence is front-loaded, but it is followed by roughly 300 words of dense domain encyclopaedia (PricePolicy, HoldingPolicy, moderation gates, publication lifecycle) that is not proportionate to a one-parameter read tool. Most sentences do not earn their place for the purpose of invoking this tool.

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?

There is no output schema, so the description carries the burden of describing what the Workshop configuration field contains. It does supply that picture in detail (ContentTypes, AccessModes, moderation, Featured), which meaningfully helps an agent interpret the return. It is over-long but not incomplete for this tool.

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 description coverage is 100% for the single title_id parameter, so the schema already documents it. The description adds no additional meaning about title_id format or sourcing. Baseline 3 is appropriate when the schema does the heavy lifting.

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 opening sentence states a specific verb and resource: "GET ONLY the 'Workshop' field of TitlePublicConfigurationModel." It also draws a scope boundary (workshop licenses vs. Marketplace escrow) that helps an agent distinguish it from get_marketplace. However, the actual purpose is buried under a data-dictionary dump of the domain model rather than being the organizing idea.

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?

There is no explicit when-to-use guidance or routing to alternatives like save_workshop or get_title_data. The negative statement that publications/licenses/reactions/reports are "NOT here" clarifies the return scope but not when an agent should call this tool versus another. Usage context is only implied by the 'GET ONLY' phrasing.

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.