​
Shinkai Tools

Tools are powerful software units that extend Shinkai’s capabilities, allowing you to automate tasks and integrate external services. Think of them as specialized functions that take specific inputs and produce outputs, making them perfect for both simple automation and complex workflows.

Many tools require configuration before they can be used effectively. This might include setting up API keys, authentication credentials, or specific parameters that customize how the tool operates. For example, a tool that interacts with your email might need your email server settings, while a tool that analyzes images might need API keys for computer vision services.

​
Accessing Tools

To access the Tools section:

  1. Open the Settings menu and select General Settings
  2. Scroll to the bottom and enable the Enable Experimental Features toggle
  3. Once enabled, you’ll see the Shinkai Tools icon (🛠️) in the left menu
  4. Click the Shinkai Tools icon to access the Tools section

​
Tools Section Overview

The Tools section provides a comprehensive view of all available tools. Here’s what you’ll find:

  • Search Bar: Quickly find specific tools
  • Import Tool: Add new tools using a URL
  • Create Tool: Build your own custom tools
  • Tool List: Browse all available tools, each showing:
    • Name and version
    • Description
    • Configuration options
    • Enable/disable toggle

​
Creating a New Tool

To create a new tool:

  1. Click the Create Tool button in the Tools section.
  2. Choose your preferred language (Python or TypeScript)
  3. Provide to the LLM in the chat an initial prompt describing your tool’s functionality
  4. The system will generate initial code and metadata
  5. Modify the generated code in the editor as needed.
  6. To switch between code and metadata use the labeled tabs above the editor.
  7. Review and update the metadata JSON to define inputs, outputs, and configuration. You can automatically regenerate the metadata based on the code pressing the “Regenerate Metadata” button on the top-right corner.

​
Testing in the Playground

The Tool Playground allows you to test your tools before deployment:

  1. Access the playground from the tool’s configuration page
  2. Fill in the required input and configuration fields
  3. Click “Run” to test the tool
  4. Review the output and execution logs
  5. Make adjustments to the code or metadata as needed

​
Configuring Tools

Most tools require configuration before use, once the tool is saved from the Tool’s Playground, you will be directed to the configuration page. If you want to modify a tool’s config you can:

  1. Click the Configure button next to a tool in the Shinkai Tools section
  2. Click on the Configuration tab
  3. Set required parameters (e.g., API keys, credentials)
  4. Save your configuration
  5. Optional: Export the tool as a ZIP file for sharing
  6. Optional: Delete the tool if no longer needed

​
Using Tools in Chat

Once configured, you can use tools directly in any chat:

  1. Start or open a chat conversation
  2. Type your request or the tool’s name
  3. Select the suggested tool from the chips that appear
  4. Provide any additional context needed
  5. The tool will execute and return results through the chat

The execution log will be displayed at the top of the response, showing the raw output before AI processing.