Skip to main content
Glama

Update a Kong entity

kong_update

Partially update a Kong entity by sending only the fields to change via PATCH request. Supports services, routes, consumers, plugins, and nested resources.

Instructions

Partially update an entity (PATCH //). Only the fields supplied in data are changed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe entity's id (UUID) or unique name/slug.
dataYesFields to update (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. It correctly discloses that the tool performs partial updates (PATCH) and changes only fields in `data`. It does not cover side effects, permissions, or error behavior, but the core behavior is adequately stated.

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: two sentences, no filler, front-loaded with the HTTP method and key behavior. Every sentence adds value.

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 no output schema, the description should hint at return values; it does not. It also lacks error handling or prerequisites. However, for a simple update tool with 4 well-documented params, the core functionality is covered.

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 baseline is 3. The description adds minimal meaning beyond the schema: it clarifies that only fields in `data` are changed, which is implicit from PATCH but reinforces intent. No parameter-specific enrichment is provided.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool performs a partial update using PATCH, specifying the resource pattern and noting that only supplied fields change. It is specific enough to distinguish from create (full entity creation) and upsert, though it does not explicitly name sibling alternatives.

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

Usage Guidelines3/5

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

The description implies use for partial updates by explaining the PATCH semantics, but it does not provide explicit guidance on when to use this tool versus alternatives like kong_create or kong_upsert, nor does it mention when not to use it.

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