Skip to main content
Glama
I4cTime

q-ring

by I4cTime
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

teleport_unpack

DestructiveIdempotent

Decrypt a packed bundle and import each contained secret into the local keyring. Preview with dryRun first; v1 requires passphrase, v2 uses your keyring identity.

Instructions

[teleport] Decrypt a bundle produced by teleport_pack and import each contained secret into the local keyring. Use on the receiving machine after a packer hands you the bundle; prefer dryRun=true first to preview what will be written. Passphrase (v1) bundles need passphrase. Recipient (v2) bundles need no input: this machine's teleport identity is read from the OS keyring (create one with qring teleport keygen; the private key is never returned). When dryRun is false this mutates the keyring (one 'write' event per imported secret) at the requested scope. Bad passphrase, missing identity, not-a-recipient or tampered bundle returns JSON { ok: false, error: { message } } with isError: true. On success returns 'Imported N secret(s) from teleport bundle'; in dryRun mode returns 'Would import N secrets:' followed by a KEY [scope] listing (v2 also lists the recipient ids the bundle is addressed to).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orgIdNoOrganization identifier for org-scoped secrets. Required only when scope='org'. Example: 'acme-corp'.
scopeNoWhere the secret lives. 'global' = user keyring (default if omitted on reads), 'project' = scoped to projectPath, 'team' = team-shared (needs teamId), 'org' = org-shared (needs orgId).global
bundleYesBase64-encoded ciphertext returned by `teleport_pack`. Pass through whitespace untouched if possible.
dryRunNoIf true, decrypt and report what would be written but do not mutate the keyring. Useful for verifying bundle contents before commit.
teamIdNoTeam identifier for team-scoped secrets. Required only when scope='team'. Example: 'acme-platform'.
passphraseNoThe passphrase used to pack a v1 bundle. Omit for v2 recipient bundles (decrypted with this machine's keyring identity). Bad passphrases return an authentication error rather than wrong plaintext.
projectPathNoAbsolute path to the project root for project-scoped secrets and policy resolution. Defaults to the MCP server's current working directory when omitted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.18.0
    • changedInput schema / properties / passphrase / description
      Previous value: -"The same passphrase that was used to pack this bundle. Bad passphrases return an authentication error rather than wrong plaintext."New value: +"The passphrase used to pack a v1 bundle. Omit for v2 recipient bundles (decrypted with this machine's keyring identity). Bad passphrases return an authentication error rather than wrong plaintext."
    • changedInput schema / required
      Previous value: -[
-  "bundle",
-  "passphrase"
-]New value: +[
+  "bundle"
+]
  2. Changed7 schema fields changedv0.11.7
    • changedInput schema / properties / bundle / description
      Previous value: -"Base64-encoded encrypted bundle"New value: +"Base64-encoded ciphertext returned by `teleport_pack`. Pass through whitespace untouched if possible."
    • changedInput schema / properties / dryRun / description
      Previous value: -"Preview without importing"New value: +"If true, decrypt and report what would be written but do not mutate the keyring. Useful for verifying bundle contents before commit."
    • changedInput schema / properties / orgId / description
      Previous value: -"Org identifier for org-scoped secrets"New value: +"Organization identifier for org-scoped secrets. Required only when scope='org'. Example: 'acme-corp'."
    • changedInput schema / properties / passphrase / description
      Previous value: -"Decryption passphrase"New value: +"The same passphrase that was used to pack this bundle. Bad passphrases return an authentication error rather than wrong plaintext."
    • changedInput schema / properties / projectPath / description
      Previous value: -"Project root path for project-scoped secrets"New value: +"Absolute path to the project root for project-scoped secrets and policy resolution. Defaults to the MCP server's current working directory when omitted."
    • changedInput schema / properties / scope / description
      Previous value: -"Scope: global, project, team, or org"New value: +"Where the secret lives. 'global' = user keyring (default if omitted on reads), 'project' = scoped to projectPath, 'team' = team-shared (needs teamId), 'org' = org-shared (needs orgId)."
    • changedInput schema / properties / teamId / description
      Previous value: -"Team identifier for team-scoped secrets"New value: +"Team identifier for team-scoped secrets. Required only when scope='team'. Example: 'acme-platform'."
  3. Changed4 schema fields changedv0.11.5
    • addedInput schema / properties / orgId
      Added value: +{
+  "description": "Org identifier for org-scoped secrets",
+  "type": "string"
+}
    • changedInput schema / properties / scope / description
      Previous value: -"Scope: global or project"New value: +"Scope: global, project, team, or org"
    • changedInput schema / properties / scope / enum
      Previous value: -[
-  "global",
-  "project"
-]New value: +[
+  "global",
+  "project",
+  "team",
+  "org"
+]
    • addedInput schema / properties / teamId
      Added value: +{
+  "description": "Team identifier for team-scoped secrets",
+  "type": "string"
+}
  4. First observedv0.1.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already mark this as destructive and non-read-only, and the description adds substantial behavioral detail: it mutates the keyring when dryRun is false, emits one write event per secret, reads identity from the OS keyring, never returns the private key, and specifies error conditions and return formats. This goes well beyond the annotations and gives the agent a clear model of side effects.

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 every sentence earns its place: purpose, usage context, dryRun guidance, v1/v2 distinction, side effects, error shape, and return values. It is front-loaded with the core action and then layers detail in a logical order. Nothing is redundant with the schema.

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?

For a complex 7-parameter tool with no output schema, the description covers all critical aspects: when to use, prerequisites (identity or passphrase), side effects, error responses, success responses, and dryRun behavior. It even notes that v2 bundles list recipient ids in dryRun output. An agent has enough information to invoke it correctly and interpret results.

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 meaning beyond the schema: it explains when passphrase is needed versus omitted, that bad passphrases yield an authentication error rather than wrong plaintext, and that dryRun previews without mutating. This is useful semantic context that the schema alone does not provide.

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 opens with a specific verb and resource: 'Decrypt a bundle produced by teleport_pack and import each contained secret into the local keyring.' This clearly distinguishes it from its inverse sibling teleport_pack and from other secret-import tools like import_dotenv. No ambiguity remains about what the tool accomplishes.

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 explicitly says when to use it: 'Use on the receiving machine after a packer hands you the bundle,' and recommends a safe first step: 'prefer dryRun=true first.' It also distinguishes v1 passphrase bundles from v2 recipient bundles. It does not explicitly name alternatives or state when not to use it, but the context is strong enough for an agent to select it correctly.

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