@mind-merge-ai/mind-merge v0.8.4

Mind Merge - Agent Creation Guide

This README provides guidelines on how to create and structure agent files for the Mind Merge application. Agents are AI assistants that can perform various tasks and interact with users through chat interfaces.

Table of Contents

1. Agent File Structure
2. Creating an Agent
3. Agent Properties
4. Agent Content
5. Using Agents in Chats
6. Advanced Agent Features

Agent File Structure

Agent files are stored in the ai/prompts/agents/ directory. Each agent has its own subdirectory named after the agent, containing a {agent-name}.md.liquid file.

Example:

ai/prompts/agents/test-agent/test-agent.md.liquid
ai/prompts/agents/secret-agent/secret-agent.md.liquid
ai/prompts/agents/symfony-learner/symfony-learner.md.liquid

Creating an Agent

To create a new agent:

1. Create a new directory in ai/prompts/agents/ with the agent's name.
2. Create a Markdown Liquid file named {agent-name}.md.liquid inside the new directory.
3. Add the necessary content to the file (see Agent Properties and Agent Content).

Agent Properties

Agent files use YAML front matter to define properties. The basic structure is:

---
name: agent-name
provider: openai
model: gpt-4
---

• name: The unique identifier for the agent.
• provider: The AI provider (e.g., "openai").
• model: The specific model to use (e.g., "gpt-4").

Additional properties can be added as needed, such as referencedFiles for including external files in the agent's context.

Agent Content

After the YAML front matter, add the agent's content. This typically includes:

1. A brief description of the agent's role or purpose.
2. Any specific instructions or guidelines for the agent's behavior.
3. Optional sections for handling different types of interactions or tasks.

Example:

You are a test agent

Here are the referenced files in this conversation:
{% for referencedFile in referencedFiles %}
#### {{referencedFile.path}}
`````````{{referencedFile.markdownFormat}}
{{referencedFile.content}}
`````````
{% endfor %}

Using Agents in Chats

To use an agent in a chat:

1. Create a chat file in the ai/chats/ directory with the .md extension.
2. Add the agent reference in the YAML front matter of the chat file:

---
agent: agent-name
provider: openai
model: gpt-4
---

3. Start the conversation with a user message.

Example:

---
agent: test-agent
provider: openai
model: gpt-4
---
# User
Hello, AI assistant!

Advanced Agent Features

Referenced Files

Agents can access referenced files specified in their properties or chat files. Use the referencedFiles property to include external files:

---
name: test-agent
provider: openai
model: gpt-4
referencedFiles:
  - ai/chats/gherkin-tests/docs/agent-referenced-doc.md
---

Message Caching

You can cache specific messages in the agent file to improve performance:

# System
---
cache: true
---

You are a test agent

# User
---
cache: true
---

This is an agent generated user message

Guest Agents

You can invite guest agents to a chat by mentioning them with an @ symbol:

# User
@test-guest-agent Hello, AI assistant!

This concludes the basic guide for creating and structuring agent files in the Mind Merge application. For more detailed information on specific features or advanced usage, please refer to the application's documentation or contact the development team.