Skip to main content
Glama

Get Platform Guide

get_platform_guide
Read-onlyIdempotent

Return a machine-readable Fine Structure / FSe2 guide for AI agents. Call this at the start of an MCP session to learn app files, entities, safe edit workflows, validation, publishing, A/B testing, secrets, and platform rules.

Input Schema

NameRequiredDescriptionDefault
app_idNoOptional app ID. If provided, the guide includes a safe app context summary.
sectionsNoOptional subset of guide sections to return.
task_typeNoOptional task hint, for example edit_app, direct_file_edit, seed_data, or publish_app.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / sections / items / enum
      Previous value: -[
      -  "ab_testing",
      -  "agency",
      -  "agents",
      -  "app_code",
      -  "checklists",
      -  "data_model",
      -  "direct_file_edit",
      -  "domains",
      -  "file_model",
      -  "functions",
      -  "generation",
      -  "media",
      -  "overview",
      -  "platform_requests",
      -  "publishing",
      -  "saas",
      -  "safety",
      -  "sdk",
      -  "secrets_integrations",
      -  "security",
      -  "validation"
      -]New value: +[
      +  "ab_testing",
      +  "agency",
      +  "agents",
      +  "app_code",
      +  "checklists",
      +  "data_model",
      +  "direct_file_edit",
      +  "domains",
      +  "file_model",
      +  "functions",
      +  "generation",
      +  "marketing",
      +  "media",
      +  "overview",
      +  "platform_requests",
      +  "publishing",
      +  "saas",
      +  "safety",
      +  "sdk",
      +  "secrets_integrations",
      +  "security",
      +  "validation"
      +]
  2. Changed1 schema field changed
    • changedInput schema / properties / sections / items / enum
      Previous value: -[
      -  "ab_testing",
      -  "agency",
      -  "agents",
      -  "app_code",
      -  "checklists",
      -  "data_model",
      -  "direct_file_edit",
      -  "domains",
      -  "file_model",
      -  "functions",
      -  "generation",
      -  "media",
      -  "overview",
      -  "publishing",
      -  "saas",
      -  "safety",
      -  "sdk",
      -  "secrets_integrations",
      -  "security",
      -  "validation"
      -]New value: +[
      +  "ab_testing",
      +  "agency",
      +  "agents",
      +  "app_code",
      +  "checklists",
      +  "data_model",
      +  "direct_file_edit",
      +  "domains",
      +  "file_model",
      +  "functions",
      +  "generation",
      +  "media",
      +  "overview",
      +  "platform_requests",
      +  "publishing",
      +  "saas",
      +  "safety",
      +  "sdk",
      +  "secrets_integrations",
      +  "security",
      +  "validation"
      +]
  3. Changed1 schema field changed
    • changedInput schema / properties / sections / items / enum
      Previous value: -[
      -  "ab_testing",
      -  "agency",
      -  "agents",
      -  "app_code",
      -  "checklists",
      -  "data_model",
      -  "direct_file_edit",
      -  "domains",
      -  "file_model",
      -  "generation",
      -  "media",
      -  "overview",
      -  "publishing",
      -  "saas",
      -  "safety",
      -  "sdk",
      -  "secrets_integrations",
      -  "security",
      -  "validation"
      -]New value: +[
      +  "ab_testing",
      +  "agency",
      +  "agents",
      +  "app_code",
      +  "checklists",
      +  "data_model",
      +  "direct_file_edit",
      +  "domains",
      +  "file_model",
      +  "functions",
      +  "generation",
      +  "media",
      +  "overview",
      +  "publishing",
      +  "saas",
      +  "safety",
      +  "sdk",
      +  "secrets_integrations",
      +  "security",
      +  "validation"
      +]
  4. Changed1 schema field changed
    • changedInput schema / properties / sections / items / enum
      Previous value: -[
      -  "ab_testing",
      -  "agency",
      -  "app_code",
      -  "checklists",
      -  "data_model",
      -  "direct_file_edit",
      -  "domains",
      -  "file_model",
      -  "generation",
      -  "media",
      -  "overview",
      -  "publishing",
      -  "saas",
      -  "safety",
      -  "sdk",
      -  "secrets_integrations",
      -  "security",
      -  "validation"
      -]New value: +[
      +  "ab_testing",
      +  "agency",
      +  "agents",
      +  "app_code",
      +  "checklists",
      +  "data_model",
      +  "direct_file_edit",
      +  "domains",
      +  "file_model",
      +  "generation",
      +  "media",
      +  "overview",
      +  "publishing",
      +  "saas",
      +  "safety",
      +  "sdk",
      +  "secrets_integrations",
      +  "security",
      +  "validation"
      +]
  5. Changed1 schema field changed
    • changedInput schema / properties / sections / items / enum
      Previous value: -[
      -  "ab_testing",
      -  "agency",
      -  "app_code",
      -  "checklists",
      -  "data_model",
      -  "direct_file_edit",
      -  "domains",
      -  "file_model",
      -  "generation",
      -  "overview",
      -  "publishing",
      -  "saas",
      -  "safety",
      -  "sdk",
      -  "secrets_integrations",
      -  "security",
      -  "validation"
      -]New value: +[
      +  "ab_testing",
      +  "agency",
      +  "app_code",
      +  "checklists",
      +  "data_model",
      +  "direct_file_edit",
      +  "domains",
      +  "file_model",
      +  "generation",
      +  "media",
      +  "overview",
      +  "publishing",
      +  "saas",
      +  "safety",
      +  "sdk",
      +  "secrets_integrations",
      +  "security",
      +  "validation"
      +]
  6. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive, so safety is covered. The description adds value by stating the output is machine-readable and enumerating the guide's coverage areas, giving the agent a sense of what it will receive beyond the annotations.

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 sentences, zero waste. The purpose and the when-to-call guidance are both front-loaded, and the topic enumeration is compact.

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?

No output schema exists, but the description conveys enough about return content (a guide covering the listed topics) for an agent to call it correctly. It stops short of describing structure, size, or pagination, which is a minor gap for a zero-required-parameter read 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%, so app_id, sections, and task_type are already documented in the schema. The description adds no additional semantics for these parameters, so the baseline of 3 applies.

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 ('Return') and resource ('machine-readable Fine Structure / FSe2 guide for AI agents'). The listed topics (app files, entities, safe edit workflows, validation, publishing, A/B testing, secrets, platform rules) make clear this is a documentation/onboarding tool, sharply distinguishing it from the CRUD-heavy siblings.

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?

'Call this at the start of an MCP session' gives explicit timing guidance for when to invoke it. There are no obvious competing alternatives to name, but it offers no when-not condition or indication of whether it is safe to skip when the agent already has context.

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