Skip to main content
Glama

List a workspace's API endpoints

list_endpoints
Read-only

Lists HTTP endpoints deployed for a workspace's current version; optionally include archived path versions to identify what prevents deleting a main endpoint.

Instructions

Lists the HTTP endpoints currently deployed for a workspace's current version. includeArchived:true adds pathVersions to each: every version of that path on its domain, including the disabled copies each commit archives (ids, labels, isMain) — what blocks deleting a main endpoint. Domain owner only (null otherwise).

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": {
      "workspaceId": "<workspaceId>"
    },
    "name": "list_endpoints"
  }
}

Input Schema

NameRequiredDescriptionDefault
workspaceIdYes
includeArchivedNoAlso list every version of each path (archived copies).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.53.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations only supply readOnlyHint=true; the description adds real behavioral context beyond that — the result shape when includeArchived is set (pathVersions with ids, labels, isMain) and the access restriction 'Domain owner only (null otherwise)'. The permission clause is slightly terse ('null otherwise' requires inference about what is null) but it does warn the agent about a privilege boundary.

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 the core action, then the flag behavior. The second sentence is dense and dash-heavy, layering a return-shape explanation and an access rule, but every clause carries information; no filler sentences.

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 no output schema, the description must convey return content, and it does for the includeArchived case while implying the default shape. It doesn't enumerate the standard endpoint fields returned without the flag, which is the main remaining gap for a 2-parameter read tool.

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 50%: includeArchived is documented in the schema, workspaceId is not. The description nonetheless adds substantial meaning for includeArchived — what it injects into each record, the fields of that addition, and why it matters — far beyond the schema's one-line gloss. workspaceId remains unexplained but is self-evident from the tool scope.

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?

States a specific verb ('Lists') and resource ('HTTP endpoints') scoped precisely to 'a workspace's current version'. No sibling tool lists endpoints, so the definition is unambiguous against the surrounding domain/workspace tools.

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?

Explains exactly when to set includeArchived:true (to see every version of each path, including archived copies) and ties it to a concrete use case — diagnosing what blocks deleting a main endpoint. Missing only an explicit when-not-to-use statement or a named alternative.

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