> ## Documentation Index
> Fetch the complete documentation index at: https://getomnier.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Omnier structure

> Every file, field, and value in Omnier.

Each company is one folder. The top of a file has a few short fields. The rest is normal writing. File names use lowercase with underscores.

## Files

| Name | Description |
| - | - |
| `crm/<company>/` | The folder for one company you sell to. |
| `context.md` | Where the deal stands right now. Start here. Price, budget, and deal size go here. |
| `company.md` | Basic facts about the company. |
| `people/firstname_lastname.md` | One markdown file per person. |
| `tasks/task_name.md` | One markdown file per thing you still need to do. |
| `files/name.md` | Extra notes or drafts for this company. Optional. Email and meeting updates do not change these. |
| `events.jsonl` | History of emails, meetings, and other events. Append only. |
| `docs/` | All context not about one company. |
| `docs/rules/` | Read by Omnier when handling email, calendar, and meeting meeting signals: pipeline stages, task rules, update rules. |
| `docs/sales/` | How the team sells. `other/` for everything else. |
| `docs/product/` | What you sell. |

## Context

`context.md`. Where the deal stands right now. Not old history. Not your to-do list.

| Name | Description |
| - | - |
| `type` | Always `context`. |
| `owner` | Who on your team owns this company. |
| `# <Company>` | The company name. |
| `## Summary` | Who matters, where you are, what is next. One or two sentences. |
| `## Where we are` | What is true today. Most important first. |
| `## Open` | Open questions and risks. Take a line out when it is done. |

## Company

`company.md`. Skip a body line if you do not know it.

| Name | Description |
| - | - |
| `type` | Always `company`. |
| `name` | Company name. |
| `domain` | Their website, like `acme.com`. |
| `stage` | Pipeline number from `docs/rules/pipeline_stages.md`. |
| `source` | Who reached out first. `outbound` means you did. `inbound` means they did. |
| `# Company name` | The company name. |
| `## Location` | Where they are. |
| `## Size` | How big they are. |
| `## Industry` | What kind of company they are. |
| `## Sales` | How they sell. |
| `## Stack` | Tools they use. |

## People

`people/firstname_lastname.md`

| Name | Description |
| - | - |
| `type` | Always `person`. |
| `name` | Full name. |
| `role` | Job title. |
| `email` | Work email. |
| `linkedin` | LinkedIn page. |
| `linkedin_connected` | `true` once they accepted your LinkedIn invite. |
| `replied` | `true` once they have replied at least once. Stays `true`. |
| `# <Name>` | The person's name. |
| `## Background` | Their job, team, and how long they have been there. |
| `## What they told us` | What they said. One fact per line, with when they said it. |
| `## Relationship` | How they fit in the deal, and what they care about. `decision maker`, `champion`, `user`, or `blocker`. |

## Tasks

`tasks/task_name.md`. A task is work you still owe: send a deck, book a meeting, prepare a proposal. A normal reply is not a task.

| Name | Description |
| - | - |
| `type` | Always `task`. |
| `title` | Short name for the work. |
| `owner` | Who on your team should do it. |
| `status` | `open` still to do. `done` finished. `cancelled` not doing it. |
| `created_at` | When you added it. |
| `due_at` | When it is due. Leave blank if there is no date. |
| `## Why` | Why this exists, when it came up, and who asked. |
| `## What to do` | The steps. |

## Company files

`files/name.md`. Extra notes or drafts for this company. Email and meeting updates do not change these files.

| Name | Description |
| - | - |
| `type` | Always `file`. |
| `owner` | Who on your team owns this file. |

## Events

`events.jsonl`. The history file for this company. One event per line. Only append, never edit.

| Name | Description |
| - | - |
| `timestamp` | When the event happened. |
| `type` | Event type. Listed below. |
| `source` | Where it came from. `outlook` email or calendar. `circleback` a recorded meeting. `linkedin` LinkedIn. `agent` you or your agent. |
| `people` | People on the event. |
| `description` | One short line, usually the email subject or meeting title. |
| `content` | Full text when there is any: email, message, or transcript. |

| Event type | Description |
| - | - |
| `company_created` | This company was added. |
| `person_added` | This person was added. |
| `email_sent` | You sent an email. |
| `email_received` | You got an email. |
| `email_import` | An old email thread you brought in. |
| `import_event` | Other old history you wanted to keep. |
| `linkedin_connection_sent` | You sent a LinkedIn invite. |
| `linkedin_connection_accepted` | They accepted. |
| `linkedin_message_sent` | You sent a LinkedIn message. |
| `linkedin_message_received` | You got a LinkedIn message. |
| `meeting_transcript` | What was said in a meeting. |
| `meeting_note` | Notes from a meeting. |
| `meeting_accepted` | Someone accepted a meeting invite. |
| `meeting_declined` | Someone declined a meeting invite. |
| `meeting_tentative` | Someone marked a meeting as maybe. |
| `meeting_cancelled` | The meeting was cancelled. |
| `meeting_updated` | The time or place changed. |
| `meeting_new_time_proposed` | Someone suggested a new time. |
| `meeting_invite_received` | A new meeting invite arrived. |
| `task_created` | A task was added. |
| `task_done` | A task was finished. |
| `other` | Anything that does not fit the list above. |

## Docs

`docs/` is all context not about one company. No required frontmatter. Company-specific free files go in `crm/<company>/files/`.

| Name | Description |
| - | - |
| `docs/rules/pipeline_stages.md` | Required. `## Pipeline`, then one stage per line: `N. name: explanation`. `company.md` `stage` is that number. |
| `docs/rules/task_rules.md` | When to create a task, and what kind. Email and meeting updates read this. |
| `docs/rules/update_rules.md` | Any other rule for how Omnier updates CRM files from emails and meetings. |
| `docs/sales/icp.md` | Who is a fit, and who to skip. LinkedIn sync and import read this. Signal updates do not. |
| `docs/sales/positioning.md` | How you position the product. |
| `docs/sales/messaging.md` | Message templates and tone. |
| `docs/sales/personas.md` | Who you sell to, as people. |
| `docs/sales/objections.md` | Common objections, and how you answer them. |
| `docs/sales/competitors.md` | Competitors, and how you differ. |
| `docs/sales/qualification.md` | How you qualify a deal. |
| `docs/sales/discovery_questions.md` | Questions you ask in discovery. |
| `docs/sales/problem_statement.md` | The problem you solve. |
| `docs/sales/other/` | Every other sales file. |
| `docs/product/` | What you sell: product notes, pricing, feature ideas. |

Signal updates read only the three files in `docs/rules/`. All other docs are for people and agents.

## Git

Each team workspace is a git repo.

* Signal updates commit after each change.
* Your agent should commit after it changes files.

Git is the full history of every file. Use it to see how a file changed and when, for example `context.md`.

## Agent tools in MCP

| Name | Description |
| - | - |
| `load_omnier_skill` | Teaches your agent how a file should look. Use this before changing files. |
| `read_file` | Opens a file. |
| `write_file` | Creates or updates a file. Do not use this on the history file. |
| `bash` | Lets your agent search, save history, and look at past changes. |
| `connection_info` | Lists Gmail, Outlook, and Circleback, and whether capture is on. |
| `connect_apps_to_omnier` | Returns a sign-in URL for Gmail, Outlook, or Circleback. |
| `set_ingestion` | Turns Gmail or Outlook capture on or off after the app is connected. Circleback is on when connected. |

## Agent skills in MCP

| Name | Description |
| - | - |
| `overview` | What Omnier is, and how the files fit together. |
| `get_started` | First setup: pipeline and sales docs, your companies, then connect apps. |
| `pipeline_report` | Interview, then a short pipeline or weekly sales report. |
| `linkedin_sync` | Catch up LinkedIn from the browser. It only reads. It never sends. |
| `context` | How to write `context.md`. |
| `company` | How to write `company.md`. |
| `person` | How to write a person file. |
| `task` | How to write a task file. |
| `events` | How to write history. |
| `company_files` | How to write extra company files. |
| `docs` | How to write `docs/rules/`, `docs/sales/`, and `docs/product/`. |

## Integrations

| Name | Description |
| - | - |
| Outlook | Your emails and calendar. Omnier updates the files for you. |
| Gmail | Your emails and calendar. Omnier updates the files for you. |
| Circleback | Meeting recordings. Omnier updates the files for you. |
| LinkedIn | You ask your agent to catch up. It does not run on its own. |

## Why a VM

Each team has its own Linux workspace. The files are real files. And version control is enabled with git. Your agent reads, writes, and runs shell commands on that workspace, the same way it would on a local folder.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.