Skip to main content
Glama
b-open-io

Bitcoin SV MCP Server

by b-open-io

ordinals_getInscription

Retrieve detailed inscription data, including content type, file info, origin, and status, by specifying the outpoint. Use this tool to verify NFT authenticity or explore metadata of digital artifacts on the Bitcoin SV blockchain.

Instructions

Retrieves detailed information about a specific ordinal inscription by its outpoint. Returns complete inscription data including content type, file information, inscription origin, and current status. Useful for verifying NFT authenticity or retrieving metadata about digital artifacts.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
argsYes

Implementation Reference

  • The async handler function that validates the outpoint format, fetches detailed inscription data from the GorillaPool Ordinals API, handles errors, and returns the response as formatted JSON text content block.
    async (
    	{ args }: { args: GetInscriptionArgs },
    	extra: RequestHandlerExtra,
    ) => {
    	try {
    		const { outpoint } = args;
    
    		// Validate outpoint format
    		if (!/^[0-9a-f]{64}_\d+$/i.test(outpoint)) {
    			throw new Error("Invalid outpoint format. Expected 'txid_vout'");
    		}
    
    		// Fetch inscription data from GorillaPool API
    		const response = await fetch(
    			`https://ordinals.gorillapool.io/api/inscriptions/${outpoint}`,
    		);
    
    		if (response.status === 404) {
    			return {
    				content: [
    					{
    						type: "text",
    						text: JSON.stringify({ error: "Inscription not found" }),
    					},
    				],
    			};
    		}
    
    		if (!response.ok) {
    			throw new Error(
    				`API error: ${response.status} ${response.statusText}`,
    			);
    		}
    
    		const data = (await response.json()) as InscriptionResponse;
    
    		return {
    			content: [
    				{
    					type: "text",
    					text: JSON.stringify(data, null, 2),
    				},
    			],
    		};
    	} catch (error) {
    		return {
    			content: [
    				{
    					type: "text",
    					text: error instanceof Error ? error.message : String(error),
    				},
    			],
    			isError: true,
    		};
    	}
    },
  • Zod schema for the tool's input arguments, defining 'outpoint' as a string in the format 'txid_vout'.
    export const getInscriptionArgsSchema = z.object({
    	outpoint: z.string().describe("Outpoint in format 'txid_vout'"),
    });
  • Registers the 'ordinals_getInscription' tool on the MCP server, specifying name, description, input schema, and the handler function.
    server.tool(
    	"ordinals_getInscription",
    	"Retrieves detailed information about a specific ordinal inscription by its outpoint. Returns complete inscription data including content type, file information, inscription origin, and current status. Useful for verifying NFT authenticity or retrieving metadata about digital artifacts.",
    	{
    		args: getInscriptionArgsSchema,
    	},
    	async (
    		{ args }: { args: GetInscriptionArgs },
    		extra: RequestHandlerExtra,
    	) => {
    		try {
    			const { outpoint } = args;
    
    			// Validate outpoint format
    			if (!/^[0-9a-f]{64}_\d+$/i.test(outpoint)) {
    				throw new Error("Invalid outpoint format. Expected 'txid_vout'");
    			}
    
    			// Fetch inscription data from GorillaPool API
    			const response = await fetch(
    				`https://ordinals.gorillapool.io/api/inscriptions/${outpoint}`,
    			);
    
    			if (response.status === 404) {
    				return {
    					content: [
    						{
    							type: "text",
    							text: JSON.stringify({ error: "Inscription not found" }),
    						},
    					],
    				};
    			}
    
    			if (!response.ok) {
    				throw new Error(
    					`API error: ${response.status} ${response.statusText}`,
    				);
    			}
    
    			const data = (await response.json()) as InscriptionResponse;
    
    			return {
    				content: [
    					{
    						type: "text",
    						text: JSON.stringify(data, null, 2),
    					},
    				],
    			};
    		} catch (error) {
    			return {
    				content: [
    					{
    						type: "text",
    						text: error instanceof Error ? error.message : String(error),
    					},
    				],
    				isError: true,
    			};
    		}
    	},
    );
  • Invokes registerGetInscriptionTool(server) as part of registering all ordinals tools.
    registerGetInscriptionTool(server);
  • tools/index.ts:90-90 (registration)
    Invokes registerOrdinalsTools(server) as part of registering all tools.
    registerOrdinalsTools(server);
Behavior3/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It describes the return data ('complete inscription data including content type, file information, inscription origin, and current status'), which is helpful. However, it lacks details on error handling, rate limits, authentication needs, or performance characteristics, leaving gaps for a mutation-free but data-rich tool.

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 front-loaded with the core purpose, followed by return details and usage context in two efficient sentences. Every sentence adds value without redundancy, making it appropriately sized and well-structured for quick understanding.

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?

Given the tool's complexity (data retrieval with detailed output), no annotations, and no output schema, the description is moderately complete. It outlines the purpose and return data but lacks specifics on output structure, error cases, or operational constraints, which are important for a tool with rich data returns.

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 description coverage is 0%, so the description must compensate. It adds meaning by specifying the parameter as 'outpoint' and implying its critical role in identifying the inscription, though it does not detail the format beyond what the schema provides ('Outpoint in format 'txid_vout''). For a single parameter tool, this provides adequate context, but not exhaustive detail.

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 clearly states the specific action ('retrieves detailed information') and resource ('about a specific ordinal inscription by its outpoint'), distinguishing it from siblings like ordinals_searchInscriptions (searching) or ordinals_getTokenByIdOrTicker (tokens). It provides a precise verb+resource combination that leaves no ambiguity about the tool's function.

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 states when to use this tool ('useful for verifying NFT authenticity or retrieving metadata about digital artifacts'), providing clear context. However, it does not specify when NOT to use it or name alternatives (e.g., ordinals_searchInscriptions for broader searches), which prevents a perfect score.

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

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/b-open-io/bsv-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server