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

# Share Links

> Retrieve a note's public share link over MCP (read-only)

## Overview

The `get_share_link` tool retrieves the public share link for a note. A share link lets someone open a meeting note without signing in.

**Available Tool:**

* `get_share_link` - Retrieve the current share link for a note (read-only)

<Note>
  Creating and deleting share links is not available over MCP. Those write actions need the `mcp:notes:write` scope, which the MCP server does not expose yet. Create or delete share links with the REST API instead — `PUT` / `DELETE /v1/external/notes/{noteGuid}/share-link`.
</Note>

**Primary Use Cases:**

* Check whether a note already has a public share link
* Retrieve the share URL for a note to pass it along
* Unlock a password-protected link's details by supplying the password

***

## get\_share\_link

Retrieves the current share link information for a note. Accepts either the share UUID (new format) or the note GUID (legacy). When the link is password-protected, pass `password` to verify access and unlock the full response.

**Required Scope:** `mcp:notes:read`

### Parameters

| Parameter  | Type   | Required | Description                                                |
| ---------- | ------ | -------- | ---------------------------------------------------------- |
| `noteGuid` | string | Yes      | The note GUID or share ID (UUID or noteGuid)               |
| `password` | string | No       | Password to verify if the share link is password-protected |

### Request Example

```json theme={"system"}
{
  "noteGuid": "abc123-def456-ghi789",
  "password": "xK9mP2qL"
}
```

### Response

```json theme={"system"}
{
  "shareId": "9b2f7c1a-1234-4d56-9abc-1234567890ab",
  "noteGuid": "abc123-def456-ghi789",
  "shareUrl": "https://tiro.ooo/share-links/9b2f7c1a-1234-4d56-9abc-1234567890ab",
  "hasPassword": true,
  "passwordVerified": true,
  "sharePassword": null
}
```

**Field Descriptions:**

| Field                          | Type           | Description                                                                           |
| ------------------------------ | -------------- | ------------------------------------------------------------------------------------- |
| `shareId`                      | string         | UUID token for the share link                                                         |
| `noteGuid`                     | string         | The original note GUID                                                                |
| `shareUrl`                     | string         | The public URL for accessing the shared note                                          |
| `hasPassword`                  | boolean        | Whether the link is password-protected                                                |
| `passwordVerified`             | boolean        | Present and `true` when a correct `password` was provided                             |
| `requiresPasswordVerification` | boolean        | Present and `true` when the link is password-protected and no `password` was supplied |
| `sharePassword`                | string \| null | Always `null` in responses (the password is never echoed back)                        |

<Note>
  If the link is password-protected and you call `get_share_link` without a `password`, the response includes `requiresPasswordVerification: true` and omits the verification flag. Supplying the wrong password returns `401 Unauthorized`.
</Note>

***

## Common Errors

### Note Not Found

<Error>
  ```json theme={"system"}
  {
    "error": "Note not found",
    "code": "NOTE_NOT_FOUND",
    "statusCode": 404
  }
  ```
</Error>

**Solution:** Verify the `noteGuid` is correct. Use `search_notes` to find valid note identifiers.

### Share Link Not Found

<Error>
  ```json theme={"system"}
  {
    "error": "No share link exists for this note",
    "code": "SHARE_LINK_NOT_FOUND",
    "statusCode": 404
  }
  ```
</Error>

**Solution:** The note does not have a share link yet. Create one in the Tiro app or with the REST API (`PUT /v1/external/notes/{noteGuid}/share-link`).

***

## Best Practices

<AccordionGroup>
  <Accordion title="Unlock password-protected links">
    When a link is password-protected, pass `password` to `get_share_link` to unlock the full response. Without it, the response sets `requiresPasswordVerification: true`.
  </Accordion>

  <Accordion title="Confirm a link exists before sharing">
    Call `get_share_link` to confirm a note has an active public link before you send the URL to someone.
  </Accordion>
</AccordionGroup>