Developer
Xtract key identity & quota
get_developer_me · Developer · Free
Use this when the user asks about their key, tier, or remaining credits, or before spending credits. Your Xtract key identity (user, prefix, environment, plan, tier, scopes) and current minute/period credit usage + reset times. current_period_credits_used is the LIVE quota counter for THIS key's environment scope and current subscription period (live and test never share a counter) — it is enforcement truth, not the user-wide report (that is get_developer_usage). 0 credits — use as a pre-flight before spending credits.
Page Sections
Request
Send a tools/call request to the MCP endpoint /xtract/mcp:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_developer_me",
"arguments": {}
}
}Parameters
No parameters.
Full input schema
{
"additionalProperties": false,
"properties": {},
"type": "object"
}Response
The outputSchema is the CLOSED model contract for structuredContent (top-level additionalProperties: false), answer-first fixed key order: source, tool, endpoint, request (echoed arguments), answer (authoritative result summary — answer from this and data), data (the complete result), included/included_digest (full expansion rows + a compact digest, when paid include expansions were served), units, answerable_fields, warnings, citations (complete visible citation array), usage (per-call cost truth), validation, and pagination (cursor/has_more/effective_limit/requested_limit). The single content block is a short plain-text answer card mirroring the same facts (header, Answer, Units, Warnings, Usage, Source). Errors return a plain-text error card and attach NO structuredContent. See How to cite ForceX MCP results.
Full output schema
{
"additionalProperties": false,
"description": "Answer-first model contract: source, tool, endpoint, request, answer, data, included?, included_digest?, units, answerable_fields, warnings, citations, usage, validation, pagination?. Errors attach NO structuredContent (plain-text error card in content).",
"properties": {
"answer": {
"description": "Authoritative result summary — answer from this and `data`.",
"type": "string"
},
"answerable_fields": {
"items": {
"type": "string"
},
"type": "array"
},
"citations": {
"items": {
"additionalProperties": true,
"description": "Visible citation (optional keys null-elided).",
"properties": {
"docs_url": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"source": {
"type": "string"
},
"title": {
"type": "string"
},
"tool": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"source",
"tool",
"endpoint",
"docs_url"
],
"type": "object"
},
"type": "array"
},
"data": {
"additionalProperties": true,
"properties": {
"current_minute_credits_limit": {
"type": "integer"
},
"current_minute_credits_used": {
"type": "integer"
},
"current_period_credits_limit": {
"type": "integer"
},
"current_period_credits_used": {
"type": "integer"
},
"environment": {
"type": "string"
},
"key_prefix": {
"type": "string"
},
"minute_reset_in_seconds": {
"type": "integer"
},
"period_end": {
"type": "string"
},
"period_reset_in_seconds": {
"type": "integer"
},
"period_start": {
"type": "string"
},
"plan_code": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"tier": {
"type": "string"
}
},
"type": "object"
},
"endpoint": {
"type": "string"
},
"pagination": {
"type": [
"object",
"null"
]
},
"request": {
"type": "object"
},
"source": {
"type": "string"
},
"tool": {
"type": "string"
},
"units": {
"type": "object"
},
"usage": {
"additionalProperties": true,
"description": "Per-call cost truth; cost_note only when the charge exceeds the Free cap.",
"properties": {
"base_credit_cost": {
"type": "integer"
},
"credit_cost": {
"type": [
"integer",
"null"
]
},
"include_credit_costs": {
"type": "object"
},
"rate_limit": {
"type": [
"object",
"null"
]
}
},
"required": [
"credit_cost",
"base_credit_cost",
"include_credit_costs"
],
"type": "object"
},
"validation": {
"additionalProperties": false,
"description": "Validation state; not_applicable_reason when not chain-scope.",
"properties": {
"lag_blocks": {
"type": [
"integer",
"null"
]
},
"not_applicable_reason": {
"type": "string"
},
"scope": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"validated_at": {
"type": [
"string",
"null"
]
},
"validated_height": {
"type": [
"integer",
"null"
]
}
},
"required": [
"status"
],
"type": "object"
},
"warnings": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"source",
"tool",
"endpoint",
"request",
"answer",
"data",
"units",
"answerable_fields",
"warnings",
"citations",
"usage",
"validation"
],
"title": "Xtract key identity & quota result",
"type": "object"
}Notes
- Cost: Free. Costs and tier limits match the wrapped Xtract REST endpoint — see
get_developer_limits. - Wrapped REST endpoint: /xtract/docs/reference/developer-me/ — the full parameter, response, and methodology reference.
- Data-retrieval tool: it never creates blockchain transactions, signs messages, publishes content, or changes third-party state (
openWorldHint=false,destructiveHint=false). Successful calls consume Xtract credits and record usage on your ForceX account, soreadOnlyHint=false.