Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api-docs.tiro.ooo/llms.txt

Use this file to discover all available pages before exploring further.

Overview

The Share Links tools allow you to manage public share links for notes. Share links enable external access to meeting notes without requiring authentication. Available Tools:
  • create_share_link - Create or update a share link for a note
  • get_share_link - Retrieve the current share link for a note
  • delete_share_link - Delete a share link, revoking public access
Primary Use Cases:
  • Share meeting notes with external stakeholders
  • Generate password-protected links for sensitive content
  • Revoke access to previously shared notes

Creates a new share link for a note, or updates the existing one. Optionally protects the link with a password. Required Scope: mcp:notes:write

Parameters

ParameterTypeRequiredDescription
noteGuidstringYesThe unique GUID of the note
usePasswordbooleanNoIf true, generates a password-protected link

Request Example

{
  "noteGuid": "abc123-def456-ghi789",
  "usePassword": true
}

Response

{
  "shareId": "9b2f7c1a-1234-4d56-9abc-1234567890ab",
  "noteGuid": "abc123-def456-ghi789",
  "shareUrl": "https://tiro.ooo/share-links/9b2f7c1a-1234-4d56-9abc-1234567890ab",
  "sharePassword": "xK9mP2qL",
  "hasPassword": true
}
Field Descriptions:
FieldTypeDescription
shareIdstringUUID token for the share link (used in the share URL)
noteGuidstringThe original note GUID (echoed back for reference)
shareUrlstringThe public URL for accessing the shared note
sharePasswordstring | nullPassword required to view the note (only present when usePassword is true)
hasPasswordbooleanWhether the link is password-protected
If a share link already exists for the note, calling create_share_link will update the existing link rather than creating a duplicate.

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

ParameterTypeRequiredDescription
noteGuidstringYesThe note GUID or share ID (UUID or noteGuid)
passwordstringNoPassword to verify if the share link is password-protected

Request Example

{
  "noteGuid": "abc123-def456-ghi789",
  "password": "xK9mP2qL"
}

Response

{
  "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:
FieldTypeDescription
shareIdstringUUID token for the share link
noteGuidstringThe original note GUID
shareUrlstringThe public URL for accessing the shared note
hasPasswordbooleanWhether the link is password-protected
passwordVerifiedbooleanPresent and true when a correct password was provided
requiresPasswordVerificationbooleanPresent and true when the link is password-protected and no password was supplied
sharePasswordstring | nullAlways null in responses (the password is never echoed back); use the value returned from create_share_link instead
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.

Deletes the share link for a note, immediately revoking all public access. Accepts either the share UUID or the legacy note GUID. Required Scope: mcp:notes:write

Parameters

ParameterTypeRequiredDescription
noteGuidstringYesThe note GUID or share ID (UUID or noteGuid)

Request Example

{
  "noteGuid": "abc123-def456-ghi789"
}

Response

{
  "success": true,
  "message": "⚠️ Permanently deleted share link for note 'abc123-def456-ghi789'. The URL https://tiro.ooo/share-links/... is no longer accessible. This action cannot be undone."
}
Field Descriptions:
FieldTypeDescription
successbooleanAlways true on a successful deletion
messagestringHuman-readable summary, including the previous share URL when it could be looked up
Deleting a share link is immediate and irreversible. Anyone with the previous link will no longer be able to access the note.

Common Errors

Note Not Found

Solution: Verify the noteGuid is correct. Use search_notes to find valid note identifiers. Solution: The note does not have a share link yet. Use create_share_link to create one.

Best Practices

Always enable usePassword when sharing notes that contain confidential information such as financial data, HR discussions, or strategic plans.
Periodically review active share links and delete any that are no longer needed. This reduces the risk of unintended access to meeting content.
Use get_share_link first to check if a share link already exists before creating a new one. This avoids unintentionally resetting passwords on existing links.