Skip to main content
Glama
@cmssy/mcp-server

@cmssy/mcp-server

Official

Get model

get_model
Read-only

Retrieves a data model's full structure by ID or slug, including fields, product, account and company settings and URL pattern, so you can inspect it before updates.

Instructions

Get the full details of one data model by id or slug: complete field definitions (type, options, relations, validation) the product capability config (enabled, field roles incl. the resolved roles, variantAxes) the accounts config (auth: identityField, companyField - a relation to a Company model, registration - open or closed, closed means siteMember.register refuses new sign-ups, email - whether cmssy sends verification, password reset and login change emails itself (enabled, links URL templates, templates copy overrides per kind and locale; off means the app's webhook sends them); each field's memberCanSet says whether the member may change it on their own account and send it at sign-up, never for password fields or the company field) the Company capability (company: { enabled }, null when never set; a model is at most one of product, account or company) and urlPattern, the storefront route its records' url is built from (null when none). Use before update_model and when the user asks about a model's structure.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "idOrSlug": "<idOrSlug>"
    },
    "name": "get_model"
  }
}

Input Schema

NameRequiredDescriptionDefault
idOrSlugYesThe model's id or slug (from list_models)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.73.2
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / required
      Added value: +[
      +  "idOrSlug"
      +]
  2. First observedv0.73.1

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered; the description goes further by explaining what returned values mean (e.g. registration `closed` means siteMember.register refuses new sign-ups; email `enabled` means cmssy sends verification/reset/login-change mail itself; `memberCanSet` never applies to password or company fields). These are genuine semantic disclosures, not restatements, though the density makes them hard to scan.

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

Conciseness3/5

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

The first clause is correctly front-loaded with the action, but the rest is one ~180-word run-on sentence built from nested parentheses and comma splices, with almost no sentence boundaries. The information is largely relevant and non-redundant, yet the packaging makes it hard to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/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 full burden of describing return values, and it does so thoroughly: model structure, capability config, auth/registration/email semantics, the at-most-one-of product/account/company constraint, and urlPattern with its null case. An agent can anticipate the response shape before calling.

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 `idOrSlug` parameter, so the schema already explains it and even points to list_models. The description's "by id or slug" merely echoes that, adding no format or lookup semantics beyond structured data; 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?

The opening clause states a specific verb and resource with retrieval key: "Get the full details of one data model by id or slug". It then enumerates the exact content returned (field definitions, product capability, accounts config, company capability, urlPattern), which lets an agent distinguish it from list_models and from get_page/get_form style siblings without opening a schema.

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?

The closing sentence gives concrete triggers: "Use before update_model and when the user asks about a model's structure", which is real when-to-use guidance tied to a named sibling. It stops short of 5 because there is no explicit when-not or a stated alternative for bulk/listing needs (list_models appears only incidentally in the schema).

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

Deploy Server

Other Tools