API client

Comments

Leave comment threads on collections, folders and requests in the API client, pin them to parts like Params or Body, and share them through Git.

Comments let you leave notes, questions and reviews on a collection, folder or request, the way you’d comment on a pull request. A comment can be about the whole item or one part of it, such as its Params or Body. Threads have replies and can be resolved and reopened. They’re saved in the workspace, so teammates see them when they pull from Git.

Add a comment

Open a saved request, a folder or a collection.
Click the speech-bubble button in its header. A number next to it counts the open threads.
In On, choose what the comment is about: The whole item, or one part of it.
Type in Add a comment… (@name to mention) and click Comment, or press ⌘ ↩.

Comments are only on saved items. An unsaved request tab has no comments button until you save it.

The Comments popover with a thread by Ada Lovelace pinned to Params asking whether petId should accept slugs and mentioning @linus, a reply from Linus Torvalds, Reply, Resolve and Delete buttons, a Resolved (1) checkbox, and a field to add a comment on the whole item — A thread pinned to a request's Params, with a reply.
Show resolved threads
The part the thread is about
@mentions are highlighted
Reply, Resolve or Delete the thread
Choose what a new comment is about
Write a comment

Parts you can comment on

Item	Choices in On
HTTP and GraphQL request	The whole item, URL, Params, Authorization, Headers, Body, Scripts, Docs, Response
Request of another protocol	The whole item, URL, Message, Scripts, Docs
Collection	The whole item, Overview, Authorization, Scripts, Variables
Folder	The whole item, Overview, Authorization, Scripts

The part appears as a label next to the author’s name.

Work with threads

Action	How
Reply	Click Reply under the thread, type, then click Reply. Replies are indented under the first comment.
Resolve	Click Resolve. The thread dims, gets a green Resolved label and is hidden.
Show resolved threads	Turn on Resolved (n) at the top of the panel.
Reopen	Show resolved threads and click Reopen.
Delete	Click Delete. The thread and all its replies are removed, without confirmation and without going to Recently Deleted.

Threads are listed oldest first. Each comment shows the author’s initials in a colored circle, their name and how long ago it was written.

Mentions

Write @name to point a comment at someone, for example @linus. Mentions are highlighted in the accent color. Cloak Proxy has no accounts, so a mention doesn’t send a notification; teammates see it when they pull and open the item.

Who comments are signed by

Comments are signed with your Git name, from git config --global user.name. If that isn’t set, the app uses your macOS account’s full name. The panel shows the name it’s using at the bottom: “Signed as Ada Park.”

To change it, set your Git name in Terminal and restart Cloak Proxy:

git config --global user.name "Ada Park"

Comments are saved in comments.json at the top of the workspace folder, sorted by when they were written. When there are no comments, the file is removed.

Comment on a request.
Commit and push the workspace from the Git view. comments.json is one of the changed files.
A teammate pulls. Their app reloads the workspace and the comment count appears on the request.

Each comment records the ID of the item it’s on, so comments stay attached when the item is renamed or moved.

AI assistants connected through the MCP server can read and add comments too. See MCP tools reference.

Workspace and GitCommit, pull and push the workspace.

Collections and requestsThe items you can comment on.

Examples and docsDocument requests for readers.