Skip to main content
Glama
Sign In
portkey-admin-mcp

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

update_access_policy

Destructive

Replace an access policy's complete subjects and targets to change who can access which resources. Requires the current version to avoid 409 conflicts.

Instructions

Replace an access policy's complete subjects and targets, changing access permissions. Requires the current version from get_access_policy; a stale version returns HTTP 409 without retrying. Omitted name, description, effect, and enabled retain their stored values. Returns Portkey's acknowledgement; reread before retrying a conflict.

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": {
      "subjects": "<subjects>",
      "targets": "<targets>",
      "version": "<version>",
      "id": "<id>"
    },
    "name": "update_access_policy"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesAccess policy UUID from list_access_policies or create_access_policy
nameNoPolicy name, unique within the workspace (1-64 characters)
effectNoAllow or deny access; omitted create effect is inferred, while omitted update effect keeps its stored value
enabledNoWhether the policy is enabled; creates default to true, updates preserve the stored value when omitted
targetsYesComplete target list; updates replace the existing targets
versionYesCurrent version from get_access_policy; a stale version returns HTTP 409
subjectsYesComplete subject list; updates replace the existing subjects. A side without entries matches requests without that principal
descriptionNoPolicy description; null clears it

Output Schema

NameRequiredDescriptionDefault
okYesWhether the tool call succeeded and returned structured data
dataNoStructured success payload when ok is true
errorNoStructured error payload when ok is false

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.0.9
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Addedv1.0.8

TDQS

A4.4/5.0
Behavior5/5

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

Adds substantial context beyond the destructive/non-idempotent annotations: the tool is a full replace, omitted fields (name, description, effect, enabled) retain stored values, stale versions fail with 409 and are not retried, and the agent should reread before retrying. It also notes the response is merely an acknowledgement, so the caller must verify.

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?

Four dense sentences, front-loaded with the mutation and replacement scope, followed by prerequisites, field-retention rules, and the conflict-handling note. No sentence is filler.

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

Completeness5/5

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

Covers the mutation's destructive scope, optimistic-concurrency requirement, partial-update semantics, and conflict recovery, which is everything an agent needs to call it without a wasted request. Return values are covered by the existing output schema.

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 update-specific semantics the schema does not: which optional fields are preserved when omitted and that subjects/targets are wholesale replacements. It does not describe the id/version formats further, which the schema already covers.

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?

Opens with a specific verb and resource ('Replace an access policy's complete subjects and targets') and clarifies the effect on permissions. It implicitly contrasts with create/get/delete siblings by emphasizing full-replacement semantics, though it never names a sibling to differentiate against.

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?

Explicitly routes the agent to get_access_policy first to obtain the version, and warns that a stale version produces HTTP 409 without retry. It gives clear preconditions but does not state when to choose this over create_access_policy or how to recover from other error cases.

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

Deploy Server

Other Tools