assist_with_cairo

Instructions

Implementation Reference

• src/index.ts:165-250 (handler)

  The primary handler function that executes the logic for the 'assist_with_cairo' tool. It constructs a contextual message from query, code snippets, and history, sends it to the Cairo Coder API, and returns the assistant's response or error.

  private async handleCairoAssistance(args: {
    query: string;
    codeSnippets?: string[];
    history?: string[];
  }) {
    try {
      const { query, codeSnippets, history } = args;
  
      if (!query) {
        throw new Error("Query parameter is required");
      }
  
      let contextualMessage = query;
  
      if (codeSnippets && codeSnippets.length > 0) {
        contextualMessage += `\n\nCode snippets for context:\n${codeSnippets.join("\n\n")}`;
      }
  
      if (history && history.length > 0) {
        contextualMessage = `Previous conversation context:\n${history.join("\n")}\n\nCurrent query: ${contextualMessage}`;
      }
  
      const requestBody: CairoCoderRequest = {
        messages: [
          {
            role: "user",
            content: contextualMessage,
          },
        ],
      };
  
      // Prepare headers based on mode
      const headers: Record<string, string> = {
        "Content-Type": "application/json",
        mcp: "true",
      };
  
      // Only add API key header in public API mode
      if (!this.isLocalMode && this.apiKey) {
        headers["x-api-key"] = this.apiKey;
      }
  
      const response = await fetch(this.apiUrl, {
        method: "POST",
        headers,
        body: JSON.stringify(requestBody),
      });
  
      if (!response.ok) {
        const errorText = await response.text();
        throw new Error(
          `API request failed: ${response.status} ${response.statusText} - ${errorText}`,
        );
      }
  
      const data = (await response.json()) as CairoCoderResponse;
  
      if (!data.choices || data.choices.length === 0) {
        throw new Error("No response received from Cairo Coder API");
      }
  
      const assistantResponse = data.choices[0].message.content;
  
      return {
        content: [
          {
            type: "text",
            text: assistantResponse,
          },
        ],
      };
    } catch (error) {
      const errorMessage =
        error instanceof Error ? error.message : "Unknown error occurred";
  
      return {
        content: [
          {
            type: "text",
            text: `Error: ${errorMessage}`,
          },
        ],
        isError: true,
      };
    }
  }

• src/index.ts:143-157 (registration)

  Registers the CallToolRequestSchema handler, which dispatches calls to 'assist_with_cairo' to the specific handler function.

  this.server.setRequestHandler(CallToolRequestSchema, async (request) => {
    const { name, arguments: args } = request.params;
  
    if (name === "assist_with_cairo") {
      return await this.handleCairoAssistance(
        args as {
          query: string;
          codeSnippets?: string[];
          history?: string[];
        },
      );
    }
  
    throw new Error(`Unknown tool: ${name}`);
  });

• src/index.ts:99-141 (registration)

  Registers the ListToolsRequestSchema handler that provides the definition and schema for the 'assist_with_cairo' tool.

    this.server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools: [
          {
            name: "assist_with_cairo",
            description: `Provides assistance with Cairo and Starknet development tasks through AI-powered analysis.
  
  Call this tool when the user's request involves **writing, refactoring, implementing from scratch, or completing specific parts (like TODOs)** of Cairo code or smart contracts.
  
  The tool analyzes the query and context against Cairo/Starknet best practices and documentation, returning helpful information to generate accurate code or explanations.
  
  This tool should also be called to get a better understanding of Starknet's ecosystem, features, and capacities.`,
            inputSchema: {
              type: "object",
              properties: {
                query: {
                  type: "string",
                  description:
                    "The user's question regarding Cairo and Starknet development. Try to be as specific as possible for better results (e.g., 'Using OpenZeppelin to build an ERC20' rather than just 'ERC20').",
                },
                codeSnippets: {
                  type: "array",
                  items: {
                    type: "string",
                  },
                  description:
                    "Optional: Code snippets for context. This will help the tool understand the user's intent and provide more accurate answers. Provide as much relevant code as possible to fit the user's request.",
                },
                history: {
                  type: "array",
                  items: {
                    type: "string",
                  },
                  description:
                    "Optional: The preceding conversation history. This can help the tool understand the context of the discussion and provide more accurate answers.",
                },
              },
              required: ["query"],
            },
          } as Tool,
        ],
      };
    });

• src/index.ts:111-137 (schema)

  Input schema definition specifying the parameters for the 'assist_with_cairo' tool.

  inputSchema: {
    type: "object",
    properties: {
      query: {
        type: "string",
        description:
          "The user's question regarding Cairo and Starknet development. Try to be as specific as possible for better results (e.g., 'Using OpenZeppelin to build an ERC20' rather than just 'ERC20').",
      },
      codeSnippets: {
        type: "array",
        items: {
          type: "string",
        },
        description:
          "Optional: Code snippets for context. This will help the tool understand the user's intent and provide more accurate answers. Provide as much relevant code as possible to fit the user's request.",
      },
      history: {
        type: "array",
        items: {
          type: "string",
        },
        description:
          "Optional: The preceding conversation history. This can help the tool understand the context of the discussion and provide more accurate answers.",
      },
    },
    required: ["query"],
  },