Skip to main content
Glama

Get AppDeploy SDK reference

get_appdeploy_sdk_reference
Read-onlyIdempotent

Returns types, rules, and examples for one requested SDK feature plus its dependencies. Treat this as the implementation contract for that feature and review it before writing files that use it. Call get_appdeploy_sdk_reference once per top-level SDK feature, using the singular feature field with exactly one enum value. Request one top-level SDK feature per call. Do not separately request dependency features; request the highest-level feature and use the dependencies returned with it. Dependency expansion: realtime -> realtime + api + database; auth -> auth + api; notifications -> notifications + api + auth; invites -> invites + api; database -> database + api; storage -> storage + api; secrets -> secrets + api; ai.generate -> ai.generate + api; ai.extract -> ai.extract + api; ai.ocr -> ai.ocr + api; ai.classify -> ai.classify + api; ai.scrape -> ai.scrape + api; ai.run -> ai.run + api; ai.image -> ai.image + api.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
featureYesSingle SDK feature to get docs for. Pass exactly one enum value in the singular feature field. Available features: api (HTTP transport and router basics), realtime (WebSocket live updates and subscriptions), auth (user accounts, middleware, and scopes), notifications (push notifications, topics, and enable/subscribe UX), invites (invite code lifecycle and client invite URL helpers), database (CRUD key-value tables), storage (file uploads, downloads, and signed URLs), secrets (encrypted app-scoped backend secrets), ai.generate (single LLM text or multimodal generation), ai.extract (schema-based structured extraction), ai.ocr (image OCR and transcription), ai.classify (fixed-label text or image classification), ai.scrape (AI-friendly web page scraper), ai.run (bounded generate-to-tool loops), ai.image (image generation), cron (scheduled jobs). Choose features by scenario: Use api for standard backend HTTP routes and transport basics; realtime for live cross-client sync and subscriptions; auth for sign-in, user identity, and protected app state; notifications for push delivery and enable/subscribe UX; invites for share links, join codes, and invite lifecycle flows; database for persisted CRUD records; storage for file uploads/downloads and signed URLs; secrets for backend-only credentials or API keys; ai.generate for single generation calls; ai.extract for schema-based structured extraction; ai.ocr for OCR/transcription from images; ai.classify for fixed-label classification; ai.scrape for AI-friendly web page extraction; ai.run for bounded multi-step AI tool loops; ai.image for image generation; cron for scheduled jobs. Call get_appdeploy_sdk_reference once per top-level SDK feature, using the singular feature field with exactly one enum value. Request one top-level SDK feature per call. Do not separately request dependency features; request the highest-level feature and use the dependencies returned with it. Dependency expansion: realtime -> realtime + api + database; auth -> auth + api; notifications -> notifications + api + auth; invites -> invites + api; database -> database + api; storage -> storage + api; secrets -> secrets + api; ai.generate -> ai.generate + api; ai.extract -> ai.extract + api; ai.ocr -> ai.ocr + api; ai.classify -> ai.classify + api; ai.scrape -> ai.scrape + api; ai.run -> ai.run + api; ai.image -> ai.image + api.

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, and non-destructive behavior. The description adds useful behavioral context beyond that: dependency expansion details, the implementation-contract usage, and confirmation that it is a request for information. No contradiction 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.

Conciseness3/5

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

The description is front-loaded and clear but contains redundancy: 'Call get_appdeploy_sdk_reference once per top-level SDK feature' and 'Request one top-level SDK feature per call' are duplicative, and the dependency expansion is repeated in the schema. It is appropriately sized but not tightly written.

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?

With a single enum parameter and read-only annotations, the description covers purpose, usage constraints, dependency expansion, and implementation-contract intent. No output schema exists, but the return types ('types, rules, examples') are described sufficiently for the tool's role.

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?

The schema's feature parameter has extensive per-enum-value descriptions and scenario guidance, covering 100% of parameter semantics. The tool description largely duplicates the calling convention and dependency expansion already present in the schema, adding no additional parameter-specific meaning beyond the baseline.

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 clearly states the tool returns types, rules, and examples for one requested SDK feature plus its dependencies, and frames it as an implementation contract. This distinguishes it from sibling read tools like get_app_template or get_deploy_instructions by its specific function.

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?

Provides explicit calling conventions: one top-level feature per call, exactly one enum value, no separate dependency requests, and use the highest-level feature. It does not explicitly name alternatives or exclusions, but the contextual guidance is strong enough for an agent to know how to use it correctly.

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.

TDQS

A4.2/5.0
Disambiguation4/5

Most tools have distinct purposes, but the 5 secrets-related tools (create_secret_entry, delete_app_secrets, get_secret_entry_status, list_app_secrets, set_app_secrets) are numerous and could cause confusion. Similarly, deploy_app and apply_app_version both involve deployment but with different contexts. Overall, descriptions help differentiate, but some overlap remains.

Naming Consistency4/5

The majority of tools follow verb_noun pattern (e.g., deploy_app, get_apps). However, the src_ prefix tools (src_glob, src_grep, src_read) deviate by using a noun prefix instead of a verb, creating a slight inconsistency. Otherwise, naming is clear and predictable.

Tool Count5/5

With 21 tools, the server covers deployment, domain management, secrets, source inspection, and asset upload without being overly large. The count is well-scoped for a deployment platform, each tool serving a necessary role.

Completeness4/5

Core workflows (deploy, status, secrets, source inspection) are well-covered. However, there are minor gaps: no tool to list available templates or manage app metadata beyond deployment. The surface is mostly complete but could benefit from a few additional administrative tools.

Resources