Skip to main content
Glama

BlockVectra Docs

by com.blockvectra
OverviewDiscussionsAdmin

How to Get API Key

how_to_get_api_key
Read-only

Get instructions and endpoints for obtaining a BlockVectra API key via preferred programmatic SIWE sign-up or browser handoff, plus authentication header and URL formats for JSON-RPC and Data API.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
langNoDocumentation language: 'en' for English or 'zh' for Chinese. Defaults to 'en'.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathsYes
env_varYes
console_urlYes
auth_methodsYes
preferred_pathYes
security_noticeYes
handoff_instructionsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedOutput schema / properties / paths
      Added value: +{
+  "properties": {
+    "browser": {
+      "properties": {
+        "console_url": {
+          "type": "string"
+        },
+        "instructions": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "console_url",
+        "instructions"
+      ],
+      "type": "object"
+    },
+    "programmatic": {
+      "properties": {
+        "base_url": {
+          "type": "string"
+        },
+        "guide_url": {
+          "type": "string"
+        },
+        "notes": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "rate_limit_policy": {
+          "properties": {
+            "error_code": {
+              "type": "string"
+            },
+            "instruction": {
+              "type": "string"
+            },
+            "retry_after_header": {
+              "type": "string"
+            },
+            "status": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "error_code",
+            "status",
+            "retry_after_header",
+            "instruction"
+          ],
+          "type": "object"
+        },
+        "security": {
+          "type": "string"
+        },
+        "steps": {
+          "items": {
+            "properties": {
+              "description": {
+                "type": "string"
+              },
+              "endpoint": {
+                "type": [
+                  "string",
+                  "null"
+                ]
+              },
+              "name": {
+                "type": "string"
+              },
+              "step": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "step",
+              "name",
+              "description"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "token_lifetime": {
+          "properties": {
+            "absolute_ttl_days": {
+              "type": "number"
+            },
+            "description": {
+              "type": "string"
+            },
+            "idle_ttl_hours": {
+              "type": "number"
+            },
+            "refresh_token": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "absolute_ttl_days",
+            "idle_ttl_hours",
+            "refresh_token",
+            "description"
+          ],
+          "type": "object"
+        }
+      },
+      "required": [
+        "base_url",
+        "guide_url",
+        "steps",
+        "rate_limit_policy",
+        "token_lifetime",
+        "notes",
+        "security"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "programmatic",
+    "browser"
+  ],
+  "type": "object"
+}
    • addedOutput schema / properties / preferred_path
      Added value: +{
+  "type": "string"
+}
    • addedOutput schema / properties / security_notice
      Added value: +{
+  "type": "string"
+}
    • changedOutput schema / required
      Previous value: -[
-  "console_url",
-  "handoff_instructions",
-  "env_var",
-  "auth_methods"
-]New value: +[
+  "preferred_path",
+  "paths",
+  "console_url",
+  "handoff_instructions",
+  "env_var",
+  "auth_methods",
+  "security_notice"
+]
  2. Added

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description goes further by disclosing the concrete content of the response (sign-up paths, auth header, URL formats for both APIs), which is useful for a static-reference tool. It does not state that the content is static/versioned or how large the returned documentation is.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single dense sentence with no filler, front-loading the verb and resource before listing the returned artifacts. 'SIWE' is unexplained jargon, but that is the only friction.

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

Completeness4/5

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

An output schema exists, so return values need not be re-explained, and the description adequately frames what the call yields. For a zero-required-parameter reference tool, nothing essential to correct invocation is missing.

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 description coverage is 100% with a single enumerated 'lang' parameter already documented in the schema, so the schema does the heavy lifting. The description says nothing about localization or the language option, adding no meaning beyond the structured field; baseline 3 applies.

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?

States a specific verb and resource: 'Get instructions and endpoints for obtaining a BlockVectra API key,' and enumerates the payload (auth header, URL formats for JSON-RPC and Data API). It is distinguishable from the docs-family siblings (list_docs, read_doc, search_docs) in substance, but never says so explicitly, leaving the agent to infer why this is not just a search_docs query.

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?

Usage is strongly implied — an agent needing credentials or request-format details should call this — and the mention of 'preferred programmatic SIWE sign-up or browser handoff' hints at two paths. However, there is no explicit when-to-use, no when-not-to-use, and no routing against the sibling documentation tools that could plausibly cover the same ground.

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

All BlockVectra Docs toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources