Sypha AI Docs
Exploring syphas tools

Sypha Tools Reference Guide

What Can Sypha Accomplish?

Sypha serves as your AI assistant capable of:

  • Editing and creating files within your project
  • Executing terminal commands
  • Searching and analyzing your codebase
  • Assisting with debugging and fixing issues
  • Automating repetitive tasks
  • Integrating with external tools

Initial Steps

  1. Initiate a Task

    • Enter your request in the chat
    • Example: "Create a new React component called Header"
  2. Supply Context

    • Utilize @ mentions to include files, folders, or URLs
    • Example: "@file:src/components/App.tsx"
  3. Examine Changes

    • Sypha will display diffs prior to making changes
    • You can modify or reject changes

Primary Features

  1. File Editing

    • Generate new files
    • Alter existing code
    • Search and replace throughout files
  2. Terminal Commands

    • Execute npm commands
    • Launch development servers
    • Install dependencies
  3. Code Analysis

    • Locate and fix errors
    • Refactor code
    • Append documentation
  4. Browser Integration

    • Test web pages
    • Capture screenshots
    • Inspect console logs

Available Tools

For the most current implementation details, you can access the full source code in the Sypha repository.

Sypha has access to the following tools for various tasks:

  1. File Operations

    • write_to_file: Create or overwrite files
    • read_file: Read file contents
    • replace_in_file: Make targeted edits to files
    • search_files: Search files using regex
    • list_files: List directory contents
  2. Terminal Operations

    • execute_command: Run CLI commands
    • list_code_definition_names: List code definitions
  3. MCP Tools

    • use_mcp_tool: Use tools from MCP servers
    • access_mcp_resource: Access MCP server resources
    • Users can create custom MCP tools that Sypha can then access
    • Example: Create a weather API tool that Sypha can use to fetch forecasts
  4. Interaction Tools

    • ask_followup_question: Ask user for clarification
    • attempt_completion: Present final results

Each tool possesses specific parameters and usage patterns. Here are some examples:

  • Create a new file (write_to_file):

    <write_to_file>
    <path>src/components/Header.tsx</path>
    <content>
    // Header component code
    </content>
    </write_to_file>
  • Search for a pattern (search_files):

    <search_files>
    <path>src</path>
    <regex>function\s+\w+\(</regex>
    <file_pattern>*.ts</file_pattern>
    </search_files>
  • Execute a command (execute_command):

    <execute_command>
    <command>npm install axios</command>
    <requires_approval>false</requires_approval>
    </execute_command>

Common Tasks

  1. Create a New Component

    • "Create a new React component called Footer"
  2. Fix a Bug

    • "Fix the error in src/utils/format.ts"
  3. Refactor Code

    • "Refactor the Button component to use TypeScript"
  4. Execute Commands

    • "Run npm install to add axios"

Obtaining Help

On this page