Skip to main content
Glama

Upsert a Kong entity

kong_upsert

Create or replace a Kong entity by its ID or name. Adds the entity if absent or fully overwrites it if present.

Instructions

Create or replace an entity at a known id/name (PUT //). Creates it if absent, fully replaces it if present.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe id (UUID) or unique name/slug to upsert at.
dataYesThe full entity object (JSON).
entityYesThe Admin API collection path. Plain entity name (e.g. 'services', 'routes', 'consumers', 'plugins', 'upstreams', 'certificates') or a nested collection path (e.g. 'upstreams/my-upstream/targets', 'services/my-service/routes', 'consumers/bob/key-auth'). Common values: services, routes, consumers, consumer_groups, plugins, upstreams, certificates, ca_certificates, snis, vaults, keys, key-sets, workspaces, acls, tags, upstreams/<upstream>/targets, services/<service>/routes, services/<service>/plugins, routes/<route>/plugins, consumers/<consumer>/plugins, consumers/<consumer>/key-auth, consumers/<consumer>/basic-auth, consumers/<consumer>/jwt, consumers/<consumer>/hmac-auth, consumers/<consumer>/acls, rbac/roles, rbac/users, admins, groups, event-hooks, developers.
workspaceNoEE workspace to scope this request to. Overrides the configured default workspace. Leave empty for OSS or the 'default' workspace.
Behavior3/5

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

With no annotations, the description carries full burden but only states the HTTP method and idempotency. It does not disclose response format, error handling, or authorization requirements, which are important for a mutation tool.

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 extremely concise at two sentences, with no unnecessary words. The core action is front-loaded and clear.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (4 parameters, nested data, no output schema), the description is minimal. It lacks details on return value, workspace usage, and error states, though it covers the essential behavior.

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?

Schema coverage is 100%, so the description adds no new information beyond the schema. It mentions entity and id in context but does not enhance parameter understanding.

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 creates or replaces an entity at a known id/name, using the PUT method. It accurately distinguishes from siblings like kong_create or kong_update by emphasizing idempotent creation/replacement.

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?

The description implicitly guides when to use this tool (for idempotent upsert) but does not explicitly compare with kong_create or kong_update, nor provide exclusion criteria. It is clear enough for an experienced Kong user.

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/Monohitoxx/kongapigateway-mcp-server'

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