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

TableJSON 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",
      -  "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"
      +]
  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",
      -  "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"
      +]
  3. 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"
      +]
  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",
      -  "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"
      +]
  5. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already establish readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is settled. The description adds meaningful behavioral context beyond that by enumerating what the returned guide contains, helping the agent understand what it will receive and why it matters. No contradictions with 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, no filler, with the key action and timing front-loaded. Every phrase earns its place.

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?

For a read-only, idempotent, no-output-schema tool with three optional parameters, this description is complete. It tells the agent when to call, what the response contains, and why the call matters, leaving no critical gap.

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 the input schema already documents all three optional parameters. The description does not add parameter-level detail, but it does orient the agent toward using app_id and sections in the context of learning the platform. 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 description states a specific verb and resource ('Return a machine-readable Fine Structure / FSe2 guide') and clearly differentiates this tool from its many siblings by positioning it as the session-start onboarding resource. The list of covered topics (app files, entities, workflows, publishing, etc.) makes its scope unmistakable.

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 description gives an explicit invocation context: 'Call this at the start of an MCP session.' It does not name alternatives or exclusions, but the session-start guidance is clear enough to route an agent to this tool over the more specialized sibling tools like get_recommended_workflow or get_app_detail.

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