cairo-erc721
Generate ERC-721 compliant non-fungible token contracts using OpenZeppelin Contracts. Input name, symbol, and optional features like burnable, pausable, or royalty tracking. Outputs contract code in Markdown format.
Instructions
Make a non-fungible token per the ERC-721 standard.
Returns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| access | No | The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts. | |
| appName | No | Required when votes is enabled, for hashing and signing typed structured data. Name for domain separator implementing SNIP12Metadata trait. Prevents two applications from producing the same hash. | |
| appVersion | No | Required when votes is enabled, for hashing and signing typed structured data. Version for domain separator implementing SNIP12Metadata trait. Prevents two versions of the same application from producing the same hash. | |
| baseUri | No | A base uri for the non-fungible token. | |
| burnable | No | Whether token holders will be able to destroy their tokens | |
| enumerable | No | Whether to allow on-chain enumeration of all tokens or those owned by an account. Increases gas cost of transfers. | |
| info | No | Metadata about the contract and author | |
| mintable | No | Whether privileged accounts will be able to create more supply or emit more tokens | |
| name | Yes | The name of the contract | |
| pausable | No | Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response. | |
| royaltyInfo | No | Provides information for how much royalty is owed and to whom, based on a sale price. Follows ERC-2981 standard. | |
| symbol | Yes | The short symbol for the token | |
| upgradeable | No | Whether the smart contract is upgradeable. | |
| votes | No | Whether to keep track of individual units for voting in on-chain governance. Voting durations can be expressed as block numbers or timestamps. |
Implementation Reference
- The handler function for the 'cairo-erc721' tool. It takes input options, constructs ERC721Options, generates the Cairo contract code using the OpenZeppelin Wizard's erc721.print method, wraps it in a safe code block, and returns it as tool output.async ({ name, symbol, baseUri, burnable, pausable, mintable, enumerable, votes, royaltyInfo, appName, appVersion, access, upgradeable, info, }) => { const opts: ERC721Options = { name, symbol, baseUri, burnable, pausable, mintable, enumerable, votes, royaltyInfo, appName, appVersion, access, upgradeable, info, }; return { content: [ { type: 'text', text: safePrintCairoCodeBlock(() => erc721.print(opts)), }, ], }; },
- Zod schema defining the input shape and descriptions for the 'cairo-erc721' tool parameters.export const erc721Schema = { name: z.string().describe(commonDescriptions.name), symbol: z.string().describe(commonDescriptions.symbol), baseUri: z.string().optional().describe(cairoERC721Descriptions.baseUri), burnable: z.boolean().optional().describe(commonDescriptions.burnable), pausable: z.boolean().optional().describe(commonDescriptions.pausable), mintable: z.boolean().optional().describe(commonDescriptions.mintable), enumerable: z.boolean().optional().describe(cairoERC721Descriptions.enumerable), votes: z.boolean().optional().describe(cairoERC721Descriptions.votes), royaltyInfo: z .object({ enabled: z.boolean().describe(cairoRoyaltyInfoDescriptions.enabled), defaultRoyaltyFraction: z.string().describe(cairoRoyaltyInfoDescriptions.defaultRoyaltyFraction), feeDenominator: z.string().describe(cairoRoyaltyInfoDescriptions.feeDenominator), }) .optional() .describe(cairoCommonDescriptions.royaltyInfo), appName: z.string().optional().describe(cairoCommonDescriptions.appName), appVersion: z.string().optional().describe(cairoCommonDescriptions.appVersion), ...commonSchema, } as const satisfies z.ZodRawShape;
- packages/mcp/src/cairo/tools/erc721.ts:8-55 (registration)Registers the 'cairo-erc721' tool on the MCP server using server.tool with the tool name, detailed prompt, schema, and handler function.export function registerCairoERC721(server: McpServer): RegisteredTool { return server.tool( 'cairo-erc721', makeDetailedPrompt(cairoPrompts.ERC721), erc721Schema, async ({ name, symbol, baseUri, burnable, pausable, mintable, enumerable, votes, royaltyInfo, appName, appVersion, access, upgradeable, info, }) => { const opts: ERC721Options = { name, symbol, baseUri, burnable, pausable, mintable, enumerable, votes, royaltyInfo, appName, appVersion, access, upgradeable, info, }; return { content: [ { type: 'text', text: safePrintCairoCodeBlock(() => erc721.print(opts)), }, ], }; }, ); }
- packages/mcp/src/utils.ts:39-41 (helper)Helper function used in the handler to safely print the generated Cairo code in a Markdown block or error message if generation fails.export function safePrintCairoCodeBlock(printFn: () => string): string { return safePrintCodeBlock(printFn, 'cairo'); }
- packages/mcp/src/cairo/tools.ts:30-34 (registration)Top-level registration function for all Cairo tools, which calls registerCairoERC721 among others.export function registerCairoTools(server: McpServer) { Object.values(getRegisterFunctions(server)).forEach(registerTool => { registerTool(server); }); }