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

# Use Your Own AI App with Inkwell

> Connect Claude, ChatGPT, Gemini or another AI app to the scripts in your Inkwell Library, so you can read, search, discuss and, if you allow it, edit them.

You already have an AI app you like. Connect it to Inkwell and it can work with your scripts directly: find a scene, check a character's voice, answer a question about page 62, or, if you allow it, make the change. No copying and pasting pages into a chat.

## Before you start

* **Reading is free. Editing needs Quill Pro.** Any Inkwell account can connect an app and have it read and search your scripts. Letting it change them needs Quill Pro, which includes the free week for new accounts. See [Credits & Billing](https://docs.inkwell.app/quill-ai/credits-billing.md).
* **Only Library scripts work.** The app can see scripts in your [Inkwell Library](https://docs.inkwell.app/managing-files/inkwell-library.md), not files that live only on your device. To use one, choose **File → Add to Library** first.
* **Use this address:** `https://mcp.inkwell.app`

## Connect your app

**1. Add Inkwell in your AI app**

Paste the address above where the app asks for a server or connector. The steps for each app are below.

**2. Sign in to Inkwell**

Your browser opens Inkwell. Sign in with your usual account.

**3. Check the page, then choose Allow**

The page asks **Allow *the app*?**, shows where it will return you, and lists what the app will be able to do. Tick **Allow reading only** if you don't want it to change your scripts.

> [!NOTE]
>
> **This name was chosen by the app. Check where it will return you.** Inkwell can't verify the name an app gives itself, so check the address under it matches the app you just opened. If it doesn't, or you didn't start this, choose **Cancel**.

### Claude (claude.ai and desktop)

Open **Customize → Connectors**, choose **+ Add**, then **Add custom connector**. Name it Inkwell, paste the address, and follow the sign-in. On a Team or Enterprise plan, an owner may need to add it first.

### Claude Code

In your terminal:

```bash theme={null}
claude mcp add --transport http inkwell https://mcp.inkwell.app
```

Then type `/mcp` inside Claude Code and sign in to Inkwell. The consent page says this is an app running on a computer. That's expected; continue only because you just started it.

### ChatGPT

On ChatGPT on the web, open **Plugins**, choose **+**, then **Add custom MCP server**. Paste the address and follow the sign-in. Which plans can do this is up to OpenAI; see [their help page](https://help.openai.com/en/articles/12584461-connecting-custom-mcp-servers-in-chatgpt) if you don't see the option.

### Gemini

On the Gemini web app, open **Settings → Connected Apps**, find **Custom apps**, and add a custom app with the address. Google requires a personal Google account in the US, in English. Gemini asks you to confirm every change it makes.

On Inkwell's consent page, Gemini appears under the name **Google**. That's normal.

## What your AI app can do

**Always, once connected:**

* Find your scripts and read them whole, or by page or scene
* Search for text, including a character's lines
* List scenes, characters, locations and notes
* Check the script for consistency
* Look at structure and at how each character speaks, and spot lines that sound off-voice
* Read the title page and logline, and get a link that opens a script in Inkwell

**Only if you allow editing, with Quill Pro:**

* Create a new script, with or without text to start from
* Change lines in a script
* Add notes
* Set the logline and character details
* Move a script to Recently deleted, when you ask it to

## How edits work

* **Edits save straight away.** There's no review step and no accept button. Ask for exactly what you want.

* **AI-written text is marked** as AI-written in your script.

* **If the script is open, the app briefly takes it.** Your editor goes read-only for a moment, then picks up the change, within about a minute or when you switch back to the window. If you were typing at that instant, your last few seconds of typing may be kept as a separate copy script, as when two devices edit at once.

* **There is no undo yet.** Inkwell keeps the version from before the app's edits, but there is no way to restore it from Inkwell yet. Keep a copy of anything you'd hate to lose before you let an app edit it.

* **Deleting is the trash, never for good.** If you ask an app to delete a script, it moves to **Recently deleted**, where you can restore it for 30 days. An app can't delete anything permanently and can't delete a script you have open.

So allow editing only when you want it; otherwise tick **Allow reading only**. To change your mind later, disconnect the app and connect it again.

## Privacy

Inkwell doesn't send your scripts anywhere until an app you connected asks for them. What the app reads is sent to that app's provider and handled under **your agreement with them**, not Inkwell's. Check their terms. Inkwell's own promise, that [we never use your scripts to train AI](https://docs.inkwell.app/managing-files/inkwell-library.md), covers Inkwell only.

## See and disconnect your apps

Open [inkwell.app/profile/account](https://inkwell.app/profile/account) and find **Connected agents**. Each app shows when it was connected, when it was last used, and whether it can read or read and edit. Choose **Disconnect** and confirm. It loses access to your Library right away.

## If something goes wrong

> [accordion] The app says editing needs Quill Pro
>
> Reading works on any plan; changing a script needs Quill Pro. Upgrade at [inkwell.app/pricing](https://inkwell.app/pricing) and ask again. You don't need to reconnect.

> [accordion] The app says it can't find my script
>
> It's probably not in your Library. Choose **File → Add to Library** in Inkwell, then ask again.

> [accordion] The app says the script is too large, or a paragraph is too long
>
> Apps can't open very large scripts, or scripts with a very long single paragraph, cue or heading. Shorten what's too long, or split the script, then save and try again. For edits, ask the app to make the change in smaller parts.

> [accordion] The app says it can't edit
>
> Either you chose reading only (disconnect and reconnect with editing allowed), or another connected app is editing that script right now (wait a minute), or you took the script back in Inkwell while the edit was being made. In that case the edit wasn't saved, so ask again.

> [accordion] The app says it made too many requests
>
> There are limits to stop a runaway app: 120 requests a minute, 60 changes an hour, and 20 new scripts a day, for each connected app. The app will tell you how long to wait.

## Tool reference

For people who like to know. The app picks tools for you; you never need to name them.

| Tool | What it does |
| - | - |
| `list_scripts` | Lists your Library scripts, with links |
| `read_script` | Reads a script, whole or by page or scene |
| `get_title_page` | Reads the title page |
| `get_current_logline` | Reads the logline |
| `list_scenes`, `list_characters`, `list_locations`, `list_notes` | Lists scenes, characters, locations and notes |
| `find_text` | Searches the script |
| `list_dialogue` | Lists a character's dialogue |
| `get_character_info` | Reads a character's details |
| `check_consistency` | Checks the script for inconsistencies |
| `compute_structure` | Analyzes structure |
| `compute_character_voice_profile`, `find_off_voice_lines` | Profiles a character's voice, finds lines that don't fit it |
| `new_script` | Creates a script (editing allowed) |
| `edit_script_content` | Changes lines (editing allowed) |
| `add_note` | Adds notes (editing allowed) |
| `edit_logline`, `set_character_info` | Sets the logline and character details (editing allowed) |
| `delete_script` | Moves a script to Recently deleted (editing allowed) |


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