bsv-mcp 0.2.9 → 0.2.11

package/package.json

@@ -2,7 +2,7 @@
 	"name": "bsv-mcp",
 	"module": "dist/index.js",
 	"type": "module",
-	"version": "0.2.9",
+	"version": "0.2.11",
 	"license": "MIT",
 	"author": "satchmo",
 	"description": "A collection of Bitcoin SV (BSV) tools for the Model Context Protocol (MCP) framework",
@@ -79,6 +79,8 @@
 		"typescript": "^5.9.3"
 	},
 	"dependencies": {
+		"@1sat/actions": "0.0.27",
+		"@1sat/wallet-remote": "0.0.7",
 		"@bsv/sdk": "^2.0.6",
 		"@modelcontextprotocol/ext-apps": "^1.2.0",
 		"@modelcontextprotocol/sdk": "^1.27.1",
@@ -104,7 +106,6 @@
 		"start:next": "next start",
 		"lint": "biome check .",
 		"lint:fix": "biome check . --write",
-		"deploy": "vercel --prod",
-		"deploy:preview": "vercel"
+		"prepack": "bun run build:all"
 	}
 }

package/tools/bap/generate.test.ts

@@ -23,7 +23,7 @@ import * as utxoUtils from "../wallet/fetchPaymentUtxos";
 import { type BapGenerateArgs, registerBapGenerateTool } from "./generate";
 
 type GenericToolHandler = (
-	params: { args: BapGenerateArgs },
+	params: BapGenerateArgs,
 	extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
 ) => CallToolResult | Promise<CallToolResult>;
 
@@ -115,12 +115,13 @@ describe("BAP Generate Tool", () => {
 	it("should register bap_generate tool with the MCP server", () => {
 		registerBapGenerateTool(mockMcpServerInstance as unknown as McpServer);
 		expect(mockServerToolSpy).toHaveBeenCalledTimes(1);
-		expect(mockServerToolSpy).toHaveBeenCalledWith(
-			"bap_generate",
-			expect.any(String),
-			{ args: expect.any(Object) },
-			expect.any(Function),
-		);
+		const [name, description, schema, handler] =
+			mockServerToolSpy.mock.calls[0];
+		expect(name).toBe("bap_generate");
+		expect(typeof description).toBe("string");
+		expect(schema).toHaveProperty("alternateName");
+		expect(schema).toHaveProperty("description");
+		expect(typeof handler).toBe("function");
 	});
 
 	const getRegisteredHandler = (): GenericToolHandler => {
@@ -141,7 +142,7 @@ describe("BAP Generate Tool", () => {
 			ServerRequest,
 			ServerNotification
 		>;
-		const result = (await handler({ args: {} }, mockExtra)) as CallToolResult;
+		const result = (await handler({}, mockExtra)) as CallToolResult;
 
 		expect(result.isError).toBe(false);
 		expect(mkdirSyncSpy).toHaveBeenCalledWith(KEY_DIR, {
@@ -174,7 +175,7 @@ describe("BAP Generate Tool", () => {
 			ServerRequest,
 			ServerNotification
 		>;
-		const result = (await handler({ args: {} }, mockExtra)) as CallToolResult;
+		const result = (await handler({}, mockExtra)) as CallToolResult;
 
 		expect(result.isError).toBe(true);
 		expect(result.content?.[0]?.text).toContain(
@@ -192,7 +193,7 @@ describe("BAP Generate Tool", () => {
 			ServerRequest,
 			ServerNotification
 		>;
-		const result = (await handler({ args: {} }, mockExtra)) as CallToolResult;
+		const result = (await handler({}, mockExtra)) as CallToolResult;
 
 		expect(result.isError).toBe(true);
 		expect(result.content?.[0]?.text).toContain(
@@ -214,7 +215,7 @@ describe("BAP Generate Tool", () => {
 			ServerRequest,
 			ServerNotification
 		>;
-		const result = (await handler({ args: {} }, mockExtra)) as CallToolResult;
+		const result = (await handler({}, mockExtra)) as CallToolResult;
 
 		expect(result.isError).toBe(true);
 		expect(result.content?.[0]?.text).toContain(
@@ -236,7 +237,7 @@ describe("BAP Generate Tool", () => {
 			ServerRequest,
 			ServerNotification
 		>;
-		const result = (await handler({ args: {} }, mockExtra)) as CallToolResult;
+		const result = (await handler({}, mockExtra)) as CallToolResult;
 
 		expect(result.isError).toBe(true);
 		expect(result.content?.[0]?.text).toContain(
@@ -260,7 +261,7 @@ describe("BAP Generate Tool", () => {
 		try {
 			registerBapGenerateTool(mockMcpServerInstance as unknown as McpServer);
 			const handler = getRegisteredHandler();
-			const result = (await handler({ args: {} }, mockExtra)) as CallToolResult;
+			const result = (await handler({}, mockExtra)) as CallToolResult;
 
 			expect(result.isError).toBe(true);
 			expect(result.content?.[0]?.text).toContain(
@@ -283,7 +284,7 @@ describe("BAP Generate Tool", () => {
 			ServerRequest,
 			ServerNotification
 		>;
-		const result = (await handler({ args: {} }, mockExtra)) as CallToolResult;
+		const result = (await handler({}, mockExtra)) as CallToolResult;
 
 		expect(result.isError).toBe(true);
 		expect(result.content?.[0]?.text).toContain(
@@ -302,7 +303,7 @@ describe("BAP Generate Tool", () => {
 			ServerRequest,
 			ServerNotification
 		>;
-		const result = (await handler({ args: {} }, mockExtra)) as CallToolResult;
+		const result = (await handler({}, mockExtra)) as CallToolResult;
 
 		expect(result.isError).toBe(false);
 		expect(result.content?.[0]?.text).toContain(
@@ -333,7 +334,7 @@ describe("BAP Generate Tool", () => {
 			ServerRequest,
 			ServerNotification
 		>;
-		const result = (await handler({ args: {} }, mockExtra)) as CallToolResult;
+		const result = (await handler({}, mockExtra)) as CallToolResult;
 
 		expect(result.isError).toBe(false);
 		expect(result.content?.[0]?.text).toContain(

package/tools/index.ts

@@ -1,3 +1,5 @@
+import type { OneSatContext } from "@1sat/actions";
+import type { OneSatServices } from "@1sat/wallet-remote";
 import type { PrivateKey } from "@bsv/sdk";
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { registerA2bDiscoverTool } from "./a2b/discover";
@@ -41,6 +43,8 @@ export interface ToolsConfig {
 	wallet?: Wallet;
 	integratedWallet?: IntegratedWallet;
 	disableBroadcasting?: boolean; // For wallet tools
+	ctx?: OneSatContext;
+	services?: OneSatServices;
 }
 
 /**
@@ -81,7 +85,7 @@ export function registerAllTools(
 
 	// Register Ordinals-related tools
 	if (enableOrdinalsTools) {
-		registerOrdinalsTools(server);
+		registerOrdinalsTools(server, config.ctx);
 	}
 
 	// Register utility tools
@@ -126,9 +130,10 @@ export function registerAllTools(
 		} else if (config.wallet) {
 			// Register normal wallet tools
 			const walletToolOptions = {
-				disableBroadcasting: config.disableBroadcasting === true, // Default to false if undefined
-				enableA2bTools: enableA2bTools, // Use the already determined enableA2bTools value
+				disableBroadcasting: config.disableBroadcasting === true,
+				enableA2bTools: enableA2bTools,
 				identityPk: config.identityPk,
+				ctx: config.ctx,
 			};
 			registerWalletTools(server, config.wallet, walletToolOptions);
 		}

package/tools/ordinals/getInscription.ts

@@ -1,83 +1,33 @@
+import type { OneSatContext } from "@1sat/actions";
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import { z } from "zod";
 
-// Schema for get inscription arguments
-export const getInscriptionArgsSchema = z.object({
-	outpoint: z.string().describe("Outpoint in format 'txid_vout'"),
-});
-
-export type GetInscriptionArgs = z.infer<typeof getInscriptionArgsSchema>;
-
-// Inscription API response type
-interface InscriptionResponse {
-	outpoint: string;
-	origin: {
-		outpoint: string;
-		data?: {
-			insc?: {
-				text?: string;
-				json?: unknown;
-				file?: {
-					hash?: string;
-					size?: number;
-					type?: string;
-				};
-			};
-		};
-	};
-	height?: number;
-	idx?: number;
-	satoshis?: number;
-	script?: string;
-	spend?: string;
-	[key: string]: unknown;
-}
-
 /**
- * Register the Ordinals inscription lookup tool
+ * Register the inscription metadata lookup tool
  */
-export function registerGetInscriptionTool(server: McpServer): void {
+export function registerGetInscriptionTool(
+	server: McpServer,
+	ctx?: OneSatContext,
+): void {
 	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.",
+		"Retrieves metadata for an inscription by its outpoint. Returns content type, file info, origin, MAP data, and sequence info.",
 		{
-			...getInscriptionArgsSchema.shape,
+			outpoint: z
+				.string()
+				.describe("Outpoint in format 'txid_vout'"),
 		},
-		async (
-			{ outpoint },
-			extra: RequestHandlerExtra,
-		) => {
+		async ({ outpoint }) => {
 			try {
+				if (!ctx?.services) {
+					throw new Error("OneSat services not available");
+				}
 
-				// 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;
+				const data = await ctx.services.ordfs.getMetadata(outpoint);
 
 				return {
 					content: [

package/tools/ordinals/getTokenByIdOrTicker.ts

@@ -1,99 +1,33 @@
+import type { OneSatContext } from "@1sat/actions";
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import { z } from "zod";
 
-// Schema for get token by ID or ticker arguments
-export const getTokenByIdOrTickerArgsSchema = z
-	.object({
-		id: z
-			.string()
-			.optional()
-			.describe("BSV20 token ID in outpoint format (txid_vout)"),
-		tick: z.string().optional().describe("BSV20 token ticker symbol"),
-	})
-	.refine((data) => data.id || data.tick, {
-		message: "Either id or tick must be provided",
-	});
-
-export type GetTokenByIdOrTickerArgs = z.infer<
-	typeof getTokenByIdOrTickerArgsSchema
->;
-
-// BSV20 token response type
-interface TokenResponse {
-	id: string;
-	tick?: string;
-	sym?: string;
-	max?: string;
-	lim?: string;
-	dec?: number;
-	supply?: string;
-	amt?: string;
-	status?: number;
-	icon?: string;
-	height?: number;
-	[key: string]: unknown;
-}
-
 /**
- * Register the BSV20 token lookup tool
+ * Register the BSV21 token lookup tool
  */
-export function registerGetTokenByIdOrTickerTool(server: McpServer): void {
+export function registerGetTokenByIdOrTickerTool(
+	server: McpServer,
+	ctx?: OneSatContext,
+): void {
 	server.tool(
 		"ordinals_getTokenByIdOrTicker",
-		"Retrieves detailed information about a specific BSV-20 token by its ID or ticker symbol. Returns complete token data including ticker symbol, supply information, decimals, and current status. This tool is useful for verifying token authenticity or checking supply metrics.",
+		"Retrieves detailed information about a BSV21 token by its ID (txid_vout format). Returns token data including symbol, supply, decimals, funding status, and current state.",
 		{
 			id: z
 				.string()
-				.optional()
-				.describe("BSV20 token ID in outpoint format (txid_vout)"),
-			tick: z.string().optional().describe("BSV20 token ticker symbol"),
+				.describe("BSV21 token ID in outpoint format (txid_vout)"),
 		},
-		async (
-			{ id, tick },
-			extra: RequestHandlerExtra,
-		) => {
+		async ({ id }) => {
 			try {
-
-				// Validate that at least one of id or tick is provided
-				if (!id && !tick) {
-					throw new Error("Either token ID or ticker symbol must be provided");
-				}
-
-				// Validate ID format if provided
-				if (id && !/^[0-9a-f]{64}_\d+$/i.test(id)) {
-					throw new Error("Invalid BSV20 ID format. Expected 'txid_vout'");
-				}
-
-				// Determine which endpoint to use based on provided parameters
-				let endpoint: string;
-				if (id) {
-					endpoint = `https://ordinals.gorillapool.io/api/bsv20/id/${id}`;
-				} else {
-					endpoint = `https://ordinals.gorillapool.io/api/bsv20/tick/${tick}`;
-				}
-
-				// Fetch BSV20 token data from GorillaPool API
-				const response = await fetch(endpoint);
-
-				if (response.status === 404) {
-					return {
-						content: [
-							{
-								type: "text",
-								text: JSON.stringify({ error: "BSV20 token not found" }),
-							},
-						],
-					};
+				if (!ctx?.services) {
+					throw new Error("OneSat services not available");
 				}
 
-				if (!response.ok) {
-					throw new Error(
-						`API error: ${response.status} ${response.statusText}`,
-					);
+				if (!/^[0-9a-f]{64}_\d+$/i.test(id)) {
+					throw new Error("Invalid token ID format. Expected 'txid_vout'");
 				}
 
-				const data = (await response.json()) as TokenResponse;
+				const data = await ctx.services.bsv21.getTokenDetails(id);
 
 				return {
 					content: [

package/tools/ordinals/index.ts

@@ -1,3 +1,4 @@
+import type { OneSatContext } from "@1sat/actions";
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { registerGetInscriptionTool } from "./getInscription";
 import { registerGetTokenByIdOrTickerTool } from "./getTokenByIdOrTicker";
@@ -8,12 +9,12 @@ import { registerSearchInscriptionsTool } from "./searchInscriptions";
 /**
  * Register all Ordinals tools with the MCP server
  * @param server The MCP server instance
+ * @param ctx OneSat context for SDK service access
  */
-export function registerOrdinalsTools(server: McpServer): void {
-	// Register Ordinals-related tools
-	registerGetInscriptionTool(server);
-	registerSearchInscriptionsTool(server);
-	registerMarketListingsTool(server);
-	registerMarketSalesTool(server);
-	registerGetTokenByIdOrTickerTool(server);
+export function registerOrdinalsTools(server: McpServer, ctx?: OneSatContext): void {
+	registerGetInscriptionTool(server, ctx);
+	registerSearchInscriptionsTool(server, ctx);
+	registerMarketListingsTool(server, ctx);
+	registerMarketSalesTool(server, ctx);
+	registerGetTokenByIdOrTickerTool(server, ctx);
 }

package/tools/ordinals/marketListings.ts

@@ -1,197 +1,30 @@
+import type { OneSatContext } from "@1sat/actions";
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
-import { z } from "zod";
-
-// Enhanced schema for unified market listings arguments
-export const marketListingsArgsSchema = z.object({
-	// Common parameters
-	limit: z
-		.number()
-		.int()
-		.min(1)
-		.max(100)
-		.default(20)
-		.describe("Number of results (1-100, default 20)"),
-	offset: z.number().int().min(0).default(0).describe("Pagination offset"),
-	dir: z
-		.enum(["asc", "desc"])
-		.default("desc")
-		.describe("Sort direction (asc or desc)"),
-	address: z.string().optional().describe("Bitcoin address"),
-
-	// NFT-specific parameters
-	origin: z.string().optional().describe("Origin outpoint"),
-	mime: z.string().optional().describe("MIME type filter"),
-	num: z.string().optional().describe("Inscription number"),
-
-	// General market parameters
-	minPrice: z.number().optional().describe("Minimum price in satoshis"),
-	maxPrice: z.number().optional().describe("Maximum price in satoshis"),
-
-	// Token-specific parameters
-	tokenType: z
-		.enum(["nft", "bsv20", "bsv21", "all"])
-		.default("all")
-		.describe("Type of token to search for (nft, bsv20, bsv21, or all)"),
-	sort: z
-		.enum(["recent", "price", "num", "height", "price_per_token"])
-		.default("recent")
-		.describe("Sort method (recent, price, num, height, price_per_token)"),
-	id: z.string().optional().describe("Token ID in outpoint format"),
-	tick: z.string().optional().describe("Token ticker symbol"),
-	pending: z
-		.boolean()
-		.default(false)
-		.optional()
-		.describe("Include pending sales"),
-});
-
-export type MarketListingsArgs = z.infer<typeof marketListingsArgsSchema>;
-
-// Unified response type that covers all token types
-interface MarketListingResponse {
-	results: Array<{
-		outpoint: string;
-		origin?: {
-			outpoint: string;
-			data?: {
-				insc?: {
-					text?: string;
-					file?: {
-						type?: string;
-						size?: number;
-					};
-				};
-			};
-		};
-		data?: {
-			list?: {
-				price?: number;
-				payout?: string;
-				sale?: boolean;
-				price_per_token?: number;
-			};
-			bsv20?: {
-				id?: string;
-				tick?: string;
-				sym?: string;
-				amt?: string;
-				op?: string;
-			};
-		};
-		satoshis?: number;
-		height?: number;
-		[key: string]: unknown;
-	}>;
-	total: number;
-}
 
 /**
- * Register the unified Ordinals market listings tool
- * Handles NFTs, BSV20, and BSV21 tokens
+ * Register the market listings tool (stub — awaiting 1sat-stack implementation)
  */
-export function registerMarketListingsTool(server: McpServer): void {
+export function registerMarketListingsTool(
+	server: McpServer,
+	ctx?: OneSatContext,
+): void {
 	server.tool(
 		"ordinals_marketListings",
-		"Retrieves current marketplace listings for Bitcoin SV ordinals with flexible filtering. Supports multiple asset types (NFTs, BSV-20 tokens, BSV-21 tokens) through a unified interface. Results include listing prices, details about the assets, and seller information.",
-		{
-			...marketListingsArgsSchema.shape,
-		},
-		async (
-			{ limit, offset, sort, dir, address, origin, mime, num, minPrice, maxPrice, tokenType, id, tick, pending },
-			extra: RequestHandlerExtra,
-		) => {
-			try {
-
-				// Determine the API endpoint based on tokenType
-				let baseUrl = "https://ordinals.gorillapool.io/api";
-				let useTokenParams = false;
-
-				if (tokenType === "bsv20" || tokenType === "bsv21") {
-					baseUrl += "/bsv20/market";
-					useTokenParams = true;
-				} else if (tokenType === "nft" || tokenType === "all") {
-					baseUrl += "/market";
-				}
-
-				// Build the URL with query parameters
-				const url = new URL(baseUrl);
-				url.searchParams.append("limit", limit.toString());
-				url.searchParams.append("offset", offset.toString());
-				url.searchParams.append("dir", dir);
-
-				// Add sort parameter based on token type
-				if (useTokenParams) {
-					// BSV20/BSV21 specific sort options
-					if (
-						sort === "height" ||
-						sort === "price" ||
-						sort === "price_per_token"
-					) {
-						url.searchParams.append("sort", sort);
-					}
-					// Add token-specific parameters
-					if (tokenType === "bsv21") {
-						url.searchParams.append("type", "v2");
-					}
-					if (id) url.searchParams.append("id", id);
-					if (tick) url.searchParams.append("tick", tick);
-					if (pending !== undefined)
-						url.searchParams.append("pending", pending.toString());
-					// For BSV20/21, min/max price parameters have slightly different names
-					if (minPrice !== undefined)
-						url.searchParams.append("min_price", minPrice.toString());
-					if (maxPrice !== undefined)
-						url.searchParams.append("max_price", maxPrice.toString());
-				} else {
-					// NFT specific sort options
-					if (sort === "recent" || sort === "price" || sort === "num") {
-						url.searchParams.append("sort", sort);
-					}
-					// Add NFT-specific parameters
-					if (origin) url.searchParams.append("origin", origin);
-					if (mime) url.searchParams.append("mime", mime);
-					if (num) url.searchParams.append("num", num);
-					// For NFTs, min/max price parameters use short names
-					if (minPrice !== undefined)
-						url.searchParams.append("min", minPrice.toString());
-					if (maxPrice !== undefined)
-						url.searchParams.append("max", maxPrice.toString());
-				}
-
-				// Add common parameters
-				if (address) url.searchParams.append("address", address);
-
-				// Make the fetch request
-				const response = await fetch(url.toString());
-
-				if (!response.ok) {
-					throw new Error(
-						`API error: ${response.status} ${response.statusText}`,
-					);
-				}
-
-				const data = (await response.json()) as MarketListingResponse;
-
-				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,
-				};
-			}
+		"Query marketplace listings for ordinals and tokens. Currently awaiting 1sat-stack marketplace API implementation.",
+		{},
+		async () => {
+			return {
+				content: [
+					{
+						type: "text",
+						text: JSON.stringify({
+							error: "Marketplace listings API not yet available on 1sat-stack",
+							status: "not_implemented",
+						}),
+					},
+				],
+				isError: true,
+			};
 		},
 	);
 }