how_to_get_api_keyGet 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.
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | Response language (case-insensitive). Defaults to 'en'. |
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Output schema / anyOfAdded value: +[
+ {
+ "allOf": [
+ {
+ "properties": {
+ "auth_methods": {
+ "properties": {
+ "data_api": {
+ "properties": {
+ "example": {
+ "type": "string"
+ },
+ "header": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "header"
+ ],
+ "type": "object"
+ },
+ "json_rpc": {
+ "properties": {
+ "bearer": {
+ "type": "string"
+ },
+ "example": {
+ "type": "string"
+ },
+ "header": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "header"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "data_api",
+ "json_rpc"
+ ],
+ "type": "object"
+ },
+ "env_var": {
+ "type": "string"
+ },
+ "handoff_instructions": {
+ "type": "string"
+ },
+ "paths": {
+ "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"
+ },
+ "preferred_path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "preferred_path",
+ "paths",
+ "handoff_instructions",
+ "env_var",
+ "auth_methods"
+ ],
+ "type": "object"
+ },
+ {
+ "not": {
+ "properties": {
+ "error": {
+ "const": "invalid_tool_arguments",
+ "type": "string"
+ }
+ },
+ "required": [
+ "error"
+ ],
+ "type": "object"
+ }
+ }
+ ]
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "error": {
+ "const": "invalid_tool_arguments",
+ "type": "string"
+ },
+ "message": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "reason": {
+ "enum": [
+ "invalid_root",
+ "schema_type",
+ "schema_enum",
+ "undeclared_property",
+ "credential_field",
+ "credential_value"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "error",
+ "reason",
+ "message"
+ ],
+ "type": "object"
+ }
+]Output schema / propertiesRemoved value: -{
- "auth_methods": {
- "properties": {
- "data_api": {
- "properties": {
- "example": {
- "type": "string"
- },
- "header": {
- "type": "string"
- }
- },
- "required": [
- "header"
- ],
- "type": "object"
- },
- "json_rpc": {
- "properties": {
- "bearer": {
- "type": "string"
- },
- "example": {
- "type": "string"
- },
- "header": {
- "type": "string"
- }
- },
- "required": [
- "header"
- ],
- "type": "object"
- }
- },
- "required": [
- "data_api",
- "json_rpc"
- ],
- "type": "object"
- },
- "env_var": {
- "type": "string"
- },
- "handoff_instructions": {
- "type": "string"
- },
- "paths": {
- "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"
- },
- "preferred_path": {
- "type": "string"
- }
-}Output schema / requiredRemoved value: -[
- "preferred_path",
- "paths",
- "handoff_instructions",
- "env_var",
- "auth_methods"
-]Input schema / properties / lang / descriptionPrevious value: -"Response language. Defaults to 'en'."New value: +"Response language (case-insensitive). Defaults to 'en'."Input schema / properties / lang / enumPrevious value: -[
- "zh",
- "en",
- "ja",
- "es",
- "pt-br",
- "ko",
- "vi",
- "zh-hant",
- "id",
- "tr",
- "de",
- "fr",
- "ru"
-]New value: +[
+ "zh",
+ "en",
+ "ja",
+ "es",
+ "pt-br",
+ "ko",
+ "vi",
+ "zh-hant",
+ "id",
+ "tr",
+ "de",
+ "fr",
+ "ru",
+ "th",
+ "uk"
+]Input schema / properties / lang / descriptionPrevious value: -"Documentation language: 'en' for English or 'zh' for Chinese. Defaults to 'en'."New value: +"Response language. Defaults to 'en'."Input schema / properties / lang / enumPrevious value: -[
- "en",
- "zh"
-]New value: +[
+ "zh",
+ "en",
+ "ja",
+ "es",
+ "pt-br",
+ "ko",
+ "vi",
+ "zh-hant",
+ "id",
+ "tr",
+ "de",
+ "fr",
+ "ru"
+]Output schema / properties / console_urlRemoved value: -{
- "type": "string"
-}Output schema / properties / security_noticeRemoved value: -{
- "type": "string"
-}Output schema / requiredPrevious value: -[
- "preferred_path",
- "paths",
- "console_url",
- "handoff_instructions",
- "env_var",
- "auth_methods",
- "security_notice"
-]New value: +[
+ "preferred_path",
+ "paths",
+ "handoff_instructions",
+ "env_var",
+ "auth_methods"
+]Output schema / properties / pathsAdded 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"
+}Output schema / properties / preferred_pathAdded value: +{
+ "type": "string"
+}Output schema / properties / security_noticeAdded value: +{
+ "type": "string"
+}Output schema / requiredPrevious value: -[
- "console_url",
- "handoff_instructions",
- "env_var",
- "auth_methods"
-]New value: +[
+ "preferred_path",
+ "paths",
+ "console_url",
+ "handoff_instructions",
+ "env_var",
+ "auth_methods",
+ "security_notice"
+]Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description still adds value by spelling out what the response contains (auth header format, JSON-RPC and Data API endpoint URLs), which is more than a bare restatement of the name.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence that delivers the purpose, the two sign-up routes, and the returned material with no filler. It is dense but every clause corresponds to real content the tool returns.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a low-parameter, read-only documentation lookup with an output schema and full annotation coverage, the description supplies enough to call it correctly. The only gap is the absence of any routing hint versus the doc-search siblings.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There is one optional parameter (lang) with 100% schema description coverage and an enum of supported languages, so the schema fully documents it. The description adds nothing about language behavior, which is acceptable given the coverage baseline but no better than baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific retrieval target (instructions and endpoints for obtaining an API key) and enumerates the content returned: SIWE sign-up, browser handoff, auth header and URL formats. That clearly separates it from generic doc tools like read_doc, search_docs and list_docs, though it never explicitly contrasts itself with them.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Saying the programmatic SIWE path is 'preferred' over browser handoff gives useful guidance on choosing an onboarding route, but there is no explicit statement of when an agent should call this tool rather than search_docs or read_doc, and no prerequisites or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.