Skip to main content
Glama

project_export

Read-onlyIdempotent

Pull the entire project in one call. Returns every deployed file — static HTML/CSS/JS as text, binary assets (images, fonts, favicons, .ico/.png/.woff*/etc) base64-encoded, server functions as source — keyed by path. This is the visual-editor fast path: one call → entire project → edit → project_deploy back.

For workflows like "redesign my homepage" or "swap the color scheme on the live site," this is the entry point. Pairs with project_deploy (full replacement) and project_patch (single-file update) on the write side.

Response shape: flat files: [{ path, type, content, encoding }] array with explicit per-entry type ("static" / "binary" / "function"), plus the same files as static_files / binary_files / functions maps. SVG is utf-8 text (it's XML); PNG / ICO / fonts / etc come back base64.

static_only: true returns only the visual layer (HTML / CSS / SVG / images / fonts) and not the server functions. Typical projects have 5–10× more function bytes than static bytes, so this is the right default for design / redesign / "swap the color scheme" workflows. The functions map comes back empty; static_files and binary_files are unchanged.

For one file (e.g. just CSS), project_file_read is lighter; for the tree alone (paths + sizes, no contents), project_files_list is much cheaper.

Example:

{ "project_id": "my-saas", "static_only": true }
// Returns: {
//   project_id: "my-saas-uuid", env: "prod", version: 47,
//   files: [
//     { path: "index.html",        type: "static",   content: "<!DOCTYPE...", encoding: "utf-8" },
//     { path: "logo.svg",          type: "static",   content: "<svg...",     encoding: "utf-8" },
//     { path: "hero.jpg",          type: "binary",   content: "<base64>",    encoding: "base64" }
//   ],
//   static_files: { ... }, binary_files: { ... }, functions: {},  // the same files as maps; functions empty when static_only
//   counts: { static_files: 8, binary_files: 2, functions: 0, total: 10 }
// }

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": {
      "project_id": "<project_id>"
    },
    "name": "project_export"
  }
}

Input Schema

NameRequiredDescriptionDefault
envNoWhich environment to pull from. Defaults to "prod" (the live deployed source). Explicit "dev" requires hosted preview access for signed-in accounts on every plan.
preview_idNoExact current candidate of preview_session_id. Both fields are required together.
project_idYesProject ID, slug, subdomain, or 'default'.
static_onlyNoWhen true, skip server functions and return only static files (HTML/CSS/SVG/images/fonts). Right default for design / redesign workflows. Defaults to false.
preview_session_idNoExact open preview session paired with preview_id and env:"dev". It does not fall back to another source.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare readOnlyHint and idempotentHint; the description goes well beyond by disclosing the concrete return shape (flat files array plus static_files/binary_files/functions maps), per-type encoding rules (SVG as utf-8 XML, PNG/ICO/fonts as base64), and the fact that functions comes back empty under static_only. It also quantifies the cost tradeoff (5–10x more function bytes than static), which is exactly the kind of context annotations cannot carry.

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

Conciseness4/5

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

Front-loaded with a bolded one-line summary, then workflow guidance, then response shape, then the example — a sensible hierarchy. The prose "Response shape" paragraph overlaps substantially with the annotated JSON example, so a small amount of text is redundant.

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 return-value burden and does so fully: field names, types, encodings, counts, and empty-map behavior under static_only. For a 5-parameter read tool whose only risk is payload size, the agent has everything needed to call it correctly and interpret the result.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3; the description adds real meaning for static_only by explaining what is excluded, what stays populated, and why it is the right default for design workflows. It does not expand on env or the preview_id/preview_session_id pairing, leaving those entirely to the schema, so it stops short of a 5.

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 line states a specific verb and resource ("Pull the entire project in one call") and immediately enumerates what's included: static text, base64 binary, and server function source, keyed by path. It is unmistakably distinct from siblings like project_file_read (one file), project_files_list (tree only), and project_deploy (write side).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit when-to-use is given ("redesign my homepage," "swap the color scheme"), along with named alternatives and the condition that selects them: project_file_read for a single file, project_files_list for paths and sizes only, project_deploy for full replacement, project_patch for single-file updates. Nothing is left to inference.

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