Skip to main content
Glama

create_app_endpoint

Creates a REST endpoint for a board, letting you control exposed columns and enable per-user row access via the X-App-User header.

Instructions

Expose a board as a REST endpoint of an app: /apps/{appSlug}/api/{slug}. exposedColumns limits which columns are readable/writable. rowLevelSecurity.enabled makes the endpoint per-user: the developer's server sends X-App-User: <their user id> next to the API key, and the endpoint returns, updates and deletes ONLY that user's rows (401 without the header). Use it whenever the app has its own users.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesHuman-readable name
slugYesURL slug: lowercase letters, digits and dashes
appIdYesApp id or slug (from list_apps / create_app)
boardIdYesBoard id (from list_boards / create_board)
allowedMethodsNoHTTP methods the endpoint accepts: GET, POST, PATCH, DELETE
exposedColumnsNoColumns the endpoint reads and writes, with the JSON key each one gets; without it the endpoint returns bare metadata
organizationIdNoOrganization id; defaults to the credential organization when omitted
rowLevelSecurityNoRow-level security: when enabled, each app user sees and edits only their own rows

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 schema fields changedv0.13.0
    • addedInput schema / properties / allowedMethods / description
      Added value: +"HTTP methods the endpoint accepts: GET, POST, PATCH, DELETE"
    • addedInput schema / properties / appId / description
      Added value: +"App id or slug (from list_apps / create_app)"
    • addedInput schema / properties / boardId / description
      Added value: +"Board id (from list_boards / create_board)"
    • addedInput schema / properties / exposedColumns / description
      Added value: +"Columns the endpoint reads and writes, with the JSON key each one gets; without it the endpoint returns bare metadata"
    • addedInput schema / properties / exposedColumns / items / properties / alias / description
      Added value: +"JSON key exposed for this column: letters, digits, underscore. Never one of the reserved item fields id, title, description, status, priority, dueDate, assignedTo, createdAt, updatedAt, order, appUserId — a business status column becomes repairStatus or orderStatus, not status."
    • addedInput schema / properties / exposedColumns / items / properties / columnId / description
      Added value: +"Column id (from get_board_schema)"
    • addedInput schema / properties / exposedColumns / items / properties / readOnly / description
      Added value: +"Expose the column for reading only; writes to it are refused with 400"
    • addedInput schema / properties / name / description
      Added value: +"Human-readable name"
    • addedInput schema / properties / organizationId / description
      Added value: +"Organization id; defaults to the credential organization when omitted"
    • addedInput schema / properties / rowLevelSecurity / description
      Added value: +"Row-level security: when enabled, each app user sees and edits only their own rows"
    • addedInput schema / properties / rowLevelSecurity / properties / enabled / description
      Added value: +"Scope every request to the calling app user (X-App-User header)"
    • addedInput schema / properties / rowLevelSecurity / properties / filterByUserId / description
      Added value: +"Also filter reads to rows the user created"
    • addedInput schema / properties / slug / description
      Added value: +"URL slug: lowercase letters, digits and dashes"
  2. First observedv0.7.0

TDQS

A4.5/5.0
Behavior4/5

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

The description explains important runtime behavior, especially row-level security: the X-App-User header requirement, 401 behavior, and that only the user's rows are returned, updated, and deleted. It also clarifies readable/writable columns, which is useful beyond the annotations' readOnlyHint=false.

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?

The description is dense but efficient, front-loading the core purpose and then explaining key behavior without repeating schema details. It packs important security and column semantics into a compact, well-structured explanation.

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?

The description covers the most complex aspects: exposed columns and row-level security, including the reserved alias fields and per-user behavior. It does not describe the response format, but the schema already provides full parameter context and the output is likely a standard endpoint object, so this is a minor gap.

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

Parameters5/5

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

Every parameter is described in the schema, and the description adds meaningful semantics: exposedColumns limits read/write access, rowLevelSecurity scopes requests per user, and alias naming restrictions avoid reserved fields. This goes well beyond the baseline schema descriptions.

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's purpose: exposing a board as a REST endpoint, with the exact URL pattern. This distinguishes it from sibling tools like list_app_endpoints and update_app_endpoint while aligning with the create_app_endpoint name.

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?

It gives a strong usage condition: 'Use it whenever the app has its own users' for row-level security. It does not explicitly contrast with alternatives, but the purpose is clear enough for an agent to select it over related endpoint tools.

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