Skip to main content
Glama
openl-tablets

OpenL MCP Server

Official
by openl-tablets
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Remote

Write Project File

openl_write_project_file

Create or update project files by relative path, adding docs, schemas, or manifests. Resolve existing-file conflicts with FAIL, OVERWRITE, or SKIP, and optionally commit changes to Git.

Instructions

Create or replace a file in a project by its project-relative path. Provide UTF-8 text in 'content'. For binary files such as xlsx/images/zip, provide base64 bytes in 'blob'; its advertised JSON Schema uses contentEncoding='base64'. The legacy content + encoding='base64' form remains accepted. COMMIT: pass 'message' to commit the write to Git (a new revision is created); omit 'message' and the write stays in the project WORKING COPY (commit it later with openl_save_project). Committing saves ALL pending project changes and works only for design repositories (not 'local'). By default missing parent folders are created (createFolders=true). If the target file already EXISTS, behavior follows conflictPolicy: FAIL (default) returns an error; OVERWRITE replaces the file in place; SKIP leaves the existing file unchanged (reported skipped). Use 'branch' to pin the project's branch (omit for local/non-branch repositories). Use this to add or update docs, schemas, or manifests. (For a NEW file the tool POSTs/creates; OVERWRITE is performed via PUT/update — overwriting a module .xlsx replaces its bytes but to change a module's TABLES use openl_update_table / openl_append_table / openl_create_project_table.)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed4 schema fields changedv1.2.0
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / anyOf
      Added value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "branch": {
+        "description": "Branch the project must be on for this operation. Ignored when blank. Fails if the repository has no branches or the project is on another branch. Omit for repository 'local' and non-branch repositories.",
+        "type": "string"
+      },
+      "conflictPolicy": {
+        "description": "How to handle a target file that already exists: FAIL (default) returns an error; OVERWRITE replaces its content in place; SKIP leaves the existing file unchanged and reports it skipped. Has no effect when creating a new file.",
+        "enum": [
+          "FAIL",
+          "OVERWRITE",
+          "SKIP"
+        ],
+        "type": "string"
+      },
+      "content": {
+        "description": "UTF-8 text content.",
+        "type": "string"
+      },
+      "createFolders": {
+        "default": true,
+        "description": "If true (default), missing intermediate folders are created automatically; otherwise the parent folder must already exist.",
+        "type": "boolean"
+      },
+      "encoding": {
+        "const": "utf-8",
+        "description": "Optional explicit UTF-8 encoding; omitted means UTF-8.",
+        "type": "string"
+      },
+      "message": {
+        "description": "Optional commit message. PRESENT → the write is committed to Git after saving the project (a new revision is created). ABSENT → the write stays in the project WORKING COPY (commit it later with openl_save_project). NOTE: committing saves ALL pending project changes (OpenL has no per-file commit), and only works for design (Git) repositories — not 'local'.",
+        "type": "string"
+      },
+      "path": {
+        "description": "Project-relative path to the resource (e.g. 'rules/Model.xlsx'). Do NOT include the project name itself; paths are relative to the project root. A trailing slash denotes a folder.",
+        "minLength": 1,
+        "type": "string"
+      },
+      "projectId": {
+        "description": "Project ID returned by backend. Use the exact 'projectId' value from openl_list_projects() response without modification or reformatting.",
+        "type": "string"
+      },
+      "response_format": {
+        "default": "json",
+        "description": "Response format: 'json' for structured, round-trippable data (default), 'markdown' for human-readable output, 'markdown_concise' for a brief summary (1-2 paragraphs), or 'markdown_detailed' for full details with context",
+        "enum": [
+          "json",
+          "markdown",
+          "markdown_concise",
+          "markdown_detailed"
+        ],
+        "type": "string"
+      }
+    },
+    "required": [
+      "projectId",
+      "path",
+      "createFolders",
+      "content"
+    ],
+    "type": "object"
+  },
+  {
+    "additionalProperties": false,
+    "properties": {
+      "branch": {
+        "description": "Branch the project must be on for this operation. Ignored when blank. Fails if the repository has no branches or the project is on another branch. Omit for repository 'local' and non-branch repositories.",
+        "type": "string"
+      },
+      "conflictPolicy": {
+        "description": "How to handle a target file that already exists: FAIL (default) returns an error; OVERWRITE replaces its content in place; SKIP leaves the existing file unchanged and reports it skipped. Has no effect when creating a new file.",
+        "enum": [
+          "FAIL",
+          "OVERWRITE",
+          "SKIP"
+        ],
+        "type": "string"
+      },
+      "content": {
+        "description": "Legacy base64 binary content. Whitespace and line wrapping are accepted.",
+        "type": "string"
+      },
+      "createFolders": {
+        "default": true,
+        "description": "If true (default), missing intermediate folders are created automatically; otherwise the parent folder must already exist.",
+        "type": "boolean"
+      },
+      "encoding": {
+        "const": "base64",
+        "description": "Marks the legacy content parameter as base64.",
+        "type": "string"
+      },
+      "message": {
+        "description": "Optional commit message. PRESENT → the write is committed to Git after saving the project (a new revision is created). ABSENT → the write stays in the project WORKING COPY (commit it later with openl_save_project). NOTE: committing saves ALL pending project changes (OpenL has no per-file commit), and only works for design (Git) repositories — not 'local'.",
+        "type": "string"
+      },
+      "path": {
+        "description": "Project-relative path to the resource (e.g. 'rules/Model.xlsx'). Do NOT include the project name itself; paths are relative to the project root. A trailing slash denotes a folder.",
+        "minLength": 1,
+        "type": "string"
+      },
+      "projectId": {
+        "description": "Project ID returned by backend. Use the exact 'projectId' value from openl_list_projects() response without modification or reformatting.",
+        "type": "string"
+      },
+      "response_format": {
+        "default": "json",
+        "description": "Response format: 'json' for structured, round-trippable data (default), 'markdown' for human-readable output, 'markdown_concise' for a brief summary (1-2 paragraphs), or 'markdown_detailed' for full details with context",
+        "enum": [
+          "json",
+          "markdown",
+          "markdown_concise",
+          "markdown_detailed"
+        ],
+        "type": "string"
+      }
+    },
+    "required": [
+      "projectId",
+      "path",
+      "createFolders",
+      "content",
+      "encoding"
+    ],
+    "type": "object"
+  },
+  {
+    "additionalProperties": false,
+    "properties": {
+      "blob": {
+        "contentEncoding": "base64",
+        "contentMediaType": "application/octet-stream",
+        "description": "Binary file bytes encoded as base64. Uses JSON Schema 2020-12 contentEncoding='base64'.",
+        "format": "base64",
+        "pattern": "^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$",
+        "type": "string"
+      },
+      "branch": {
+        "description": "Branch the project must be on for this operation. Ignored when blank. Fails if the repository has no branches or the project is on another branch. Omit for repository 'local' and non-branch repositories.",
+        "type": "string"
+      },
+      "conflictPolicy": {
+        "description": "How to handle a target file that already exists: FAIL (default) returns an error; OVERWRITE replaces its content in place; SKIP leaves the existing file unchanged and reports it skipped. Has no effect when creating a new file.",
+        "enum": [
+          "FAIL",
+          "OVERWRITE",
+          "SKIP"
+        ],
+        "type": "string"
+      },
+      "createFolders": {
+        "default": true,
+        "description": "If true (default), missing intermediate folders are created automatically; otherwise the parent folder must already exist.",
+        "type": "boolean"
+      },
+      "message": {
+        "description": "Optional commit message. PRESENT → the write is committed to Git after saving the project (a new revision is created). ABSENT → the write stays in the project WORKING COPY (commit it later with openl_save_project). NOTE: committing saves ALL pending project changes (OpenL has no per-file commit), and only works for design (Git) repositories — not 'local'.",
+        "type": "string"
+      },
+      "path": {
+        "description": "Project-relative path to the resource (e.g. 'rules/Model.xlsx'). Do NOT include the project name itself; paths are relative to the project root. A trailing slash denotes a folder.",
+        "minLength": 1,
+        "type": "string"
+      },
+      "projectId": {
+        "description": "Project ID returned by backend. Use the exact 'projectId' value from openl_list_projects() response without modification or reformatting.",
+        "type": "string"
+      },
+      "response_format": {
+        "default": "json",
+        "description": "Response format: 'json' for structured, round-trippable data (default), 'markdown' for human-readable output, 'markdown_concise' for a brief summary (1-2 paragraphs), or 'markdown_detailed' for full details with context",
+        "enum": [
+          "json",
+          "markdown",
+          "markdown_concise",
+          "markdown_detailed"
+        ],
+        "type": "string"
+      }
+    },
+    "required": [
+      "projectId",
+      "path",
+      "createFolders",
+      "blob"
+    ],
+    "type": "object"
+  }
+]
    • removedInput schema / properties
      Removed value: -{
-  "branch": {
-    "description": "Branch the project must be on for this operation. Ignored when blank. Fails if the repository has no branches or the project is on another branch. Omit for repository 'local' and non-branch repositories.",
-    "type": "string"
-  },
-  "conflictPolicy": {
-    "description": "How to handle a target file that already exists: FAIL (default) returns an error; OVERWRITE replaces its content in place; SKIP leaves the existing file unchanged and reports it skipped. Has no effect when creating a new file.",
-    "enum": [
-      "FAIL",
-      "OVERWRITE",
-      "SKIP"
-    ],
-    "type": "string"
-  },
-  "content": {
-    "description": "File content, interpreted according to 'encoding'. Use base64 for binary files (xlsx, images, zip).",
-    "type": "string"
-  },
-  "createFolders": {
-    "default": true,
-    "description": "If true (default), missing intermediate folders are created automatically; otherwise the parent folder must already exist.",
-    "type": "boolean"
-  },
-  "encoding": {
-    "default": "utf-8",
-    "description": "How 'content' is encoded: 'utf-8' (default) for text, 'base64' for binary.",
-    "enum": [
-      "utf-8",
-      "base64"
-    ],
-    "type": "string"
-  },
-  "message": {
-    "description": "Optional commit message. PRESENT → the write is committed to Git after saving the project (a new revision is created). ABSENT → the write stays in the project WORKING COPY (commit it later with openl_save_project). NOTE: committing saves ALL pending project changes (OpenL has no per-file commit), and only works for design (Git) repositories — not 'local'.",
-    "type": "string"
-  },
-  "path": {
-    "description": "Project-relative path to the resource (e.g. 'rules/Model.xlsx'). Do NOT include the project name itself; paths are relative to the project root. A trailing slash denotes a folder.",
-    "minLength": 1,
-    "type": "string"
-  },
-  "projectId": {
-    "description": "Project ID returned by backend. Use the exact 'projectId' value from openl_list_projects() response without modification or reformatting.",
-    "type": "string"
-  },
-  "response_format": {
-    "default": "markdown",
-    "description": "Response format: 'json' for structured data, 'markdown' for human-readable (default), 'markdown_concise' for brief summary (1-2 paragraphs), 'markdown_detailed' for full details with context",
-    "enum": [
-      "json",
-      "markdown",
-      "markdown_concise",
-      "markdown_detailed"
-    ],
-    "type": "string"
-  }
-}
    • removedInput schema / required
      Removed value: -[
-  "projectId",
-  "path",
-  "content",
-  "encoding",
-  "createFolders"
-]
  2. Addedv1.1.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations provide only openWorldHint, so the description carries the full behavioral burden and meets it impressively. It discloses the significant side effect that committing saves ALL pending project changes (no per-file commit), the working-copy vs Git-revision distinction, the local-repository exception, folder auto-creation behavior, the FAIL/OVERWRITE/SKIP conflict semantics, branch-pinning behavior, and the module-.xlsx bytes-vs-tables nuance. No contradiction with the openWorldHint annotation.

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?

The description is long but every block earns its place given the tool's three input modalities, commit semantics, and conflict policy. It is logically front-loaded: purpose → content types → commit behavior → folder creation → conflict handling → branch → use case → table-tool routing. Minor redundancy exists where the message explanation nearly duplicates the schema's message parameter description, but this repetition is acceptable given the importance of the commit side effect.

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?

For a complex mutation tool with no output schema and minimal annotations, the description covers an exceptional amount: content types, commit side effects, conflict policies, folder creation, branch semantics, and sibling-tool routing. The remaining gaps are the return value structure (no output schema exists and the description doesn't characterize the response beyond response_format options) and permission/authentication requirements. These are minor against the overall coverage.

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 the baseline is 3, but the description adds real value by explaining the relationship between the three anyOf modalities: UTF-8 text goes in 'content', binary goes in 'blob' (with an explicit note that its schema uses contentEncoding='base64'), and the legacy content + encoding='base64' form remains accepted. This disambiguation is crucial because the raw anyOf structure alone would leave an agent unsure which branch to pick. The description also adds the 'committing saves ALL pending changes' semantic that enriches the message parameter.

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 sentence states a specific verb and resource ('Create or replace a file in a project by its project-relative path') and immediately clarifies scope. It goes further by distinguishing file writes from table operations, naming openl_update_table / openl_append_table / openl_create_project_table as the tools for changing a module's TABLES, and separating itself from the many file-sibling tools (read/delete/copy/move) via the clear create-or-replace framing.

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?

The description gives explicit when-to-use guidance: 'Use this to add or update docs, schemas, or manifests.' It also states an explicit exclusion — overwriting a module .xlsx replaces bytes only, but changing TABLES requires the table tools — and names the commit-later alternative (openl_save_project). The commit-vs-working-copy decision is spelled out in terms of message presence, leaving no ambiguity about how to select behavior.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/openl-tablets/openl-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server