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

# Create note

> MCP tool to create a private note on an entity in the Thena platform.

import Admonition from '@theme/Admonition';

### MCP tool: `create_note`

Creates a private note on any entity. Notes are automatically set to private visibility and are useful for internal documentation and team communication.

<Admonition type="note">
  Notes are automatically set to private visibility and comment type "note".
</Admonition>

### Example prompt

```prompt theme={null}
Create a note on ticket 71XNF90K10YBR86G1AN06KZJJFX40 with content "Customer requested urgent resolution"
```

<Admonition type="info">
  When you use this prompt in a chat with the model (with the MCP tool registered), the model will automatically call the <code>create\_note</code> tool with the correct arguments.
</Admonition>

### Input parameters

| Name          | Type      | Required | Description                                                                             |
| ------------- | --------- | -------- | --------------------------------------------------------------------------------------- |
| entityType    | string    | Yes      | The type of entity to add a note to (e.g., "ticket", "accountActivity", "note", "task") |
| entityId      | string    | Yes      | The ID of the entity to add a note to                                                   |
| content       | string    | No       | The plain text content of the note                                                      |
| attachmentIds | string\[] | No       | Array of attachment IDs to associate with the note                                      |
| metadata      | object    | No       | Any additional metadata (e.g., mentions, tags)                                          |

### Response fields

Below are the fields you may see in the response:

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr><td>id</td><td>string</td><td>Note unique ID</td></tr>
    <tr><td>content</td><td>string</td><td>Plain text content of the note</td></tr>
    <tr><td>contentHtml</td><td>string</td><td>HTML formatted content</td></tr>
    <tr><td>contentMarkdown</td><td>string</td><td>Markdown formatted content</td></tr>
    <tr><td>contentJson</td><td>string</td><td>JSON formatted content for rich text</td></tr>
    <tr><td>isEdited</td><td>boolean</td><td>Whether the note has been edited</td></tr>
    <tr><td>threadName</td><td>string</td><td>Name of the comment thread</td></tr>
    <tr><td>commentVisibility</td><td>string</td><td>Always "private"</td></tr>
    <tr><td>commentType</td><td>string</td><td>Always "note"</td></tr>
    <tr><td>isPinned</td><td>boolean</td><td>Whether the note is pinned</td></tr>
    <tr><td>sourceEmailId</td><td>string</td><td>Email ID if note came from email</td></tr>
    <tr><td>metadata</td><td>object</td><td>Additional metadata including mentions</td></tr>
    <tr><td>createdAt</td><td>string (ISO8601)</td><td>Creation timestamp</td></tr>
    <tr><td>updatedAt</td><td>string (ISO8601)</td><td>Last update timestamp</td></tr>
    <tr><td>author</td><td>string</td><td>Author display name</td></tr>
    <tr><td>authorAvatarUrl</td><td>string</td><td>Author's avatar URL</td></tr>
    <tr><td>attachments</td><td>array</td><td>Array of attachment IDs</td></tr>
    <tr><td>authorId</td><td>string</td><td>Author's user ID</td></tr>
    <tr><td>authorUserType</td><td>string</td><td>Author's user type (e.g., ORG\_ADMIN)</td></tr>
    <tr><td>impersonatedUserEmail</td><td>string</td><td>Email of impersonated user</td></tr>
    <tr><td>impersonatedUserName</td><td>string</td><td>Name of impersonated user</td></tr>
    <tr><td>impersonatedUserAvatar</td><td>string</td><td>Avatar of impersonated user</td></tr>
    <tr><td>deletedAt</td><td>string</td><td>Deletion timestamp (null if not deleted)</td></tr>
  </tbody>
</table>

### Sample response

```json theme={null}
{
  "data": {
    "id": "PEDCR01K10RKS0142W6FR5AYJJMYJ",
    "content": "Internal note: Customer has been experiencing intermittent issues over the past month. Consider upgrading their account to premium support tier for better monitoring.",
    "contentHtml": "",
    "contentMarkdown": "Internal note: Customer has been experiencing intermittent issues over the past month. Consider upgrading their account to premium support tier for better monitoring.",
    "contentJson": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":\"left\"}}]}",
    "isEdited": false,
    "threadName": null,
    "commentVisibility": "private",
    "commentType": "note",
    "isPinned": false,
    "sourceEmailId": null,
    "metadata": {
      "mentions": []
    },
    "createdAt": "2025-07-25T12:19:31.410Z",
    "updatedAt": "2025-07-25T12:19:31.409Z",
    "author": "shakthi+1",
    "authorAvatarUrl": null,
    "attachments": [],
    "authorId": "UTH00SEXXFNVVN",
    "authorUserType": "ORG_ADMIN",
    "impersonatedUserEmail": null,
    "impersonatedUserName": null,
    "impersonatedUserAvatar": null,
    "deletedAt": null
  },
  "status": true,
  "message": "Comment created successfully!",
  "timestamp": "2025-07-25T12:19:31.442Z"
}
```

<Admonition type="tip">
  Always pass an object as input, even if empty, to avoid errors when calling the tool directly.
</Admonition>

***