Skip to main content
Glama
yaaif

@yaaif/platform-mcp

by yaaif

yaaif_api_key_bind_deployment

Bind an API key credential to a deployment's secret env (YAAIF_MCP_PLATFORM_API_KEY) and optionally redeploy to apply it, avoiding direct platform S2S keys in MCP pods.

Instructions

Bind an API key Credentials record to an MCP deployment secret_env as YAAIF_MCP_PLATFORM_API_KEY (process fallback for ambient/desktop). Optionally redeploy so the pod picks up the env. Prefer this over putting platform S2S into MCP pods.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
env_nameNo
redeployNo
credential_idYes
deployment_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.5

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are present, so the description carries the full behavioral burden. It does disclose the exact environment variable set, the optional redeploy behavior, and why redeploy is useful. However, it does not mention permissions, idempotency, whether existing secret_env values are overwritten, or what the response contains.

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?

Three sentences, front-loaded with the core action, then the optional redeploy detail, then the usage preference. No filler or repetition; 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?

The description gives enough to attempt the core bind operation, but with no output schema and no annotations, it leaves gaps around env_name semantics, conflict behavior, required-versus-optional parameters, and side effects. Adequate but not complete for safe autonomous invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate, but it only implies credential_id and deployment_id and mentions optional redeploy. The env_name parameter is unexplained, and no parameter names are mapped to their roles or defaults.

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 states a precise action ('Bind an API key Credentials record to an MCP deployment secret_env') with a specific target and exact environment variable name (YAAIF_MCP_PLATFORM_API_KEY). This clearly differentiates it from the many sibling CRUD tools for API keys and deployments.

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 gives explicit context on when this is appropriate: it is a process fallback for ambient/desktop and should be preferred over putting platform S2S into MCP pods. It does not explicitly name alternative sibling tools or list cases where another tool should be used instead, so it falls short of full guidance.

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