Back to Anytype

Anytype Agents' Skill

anytype-docs-features-anytype-agents-skill.md

latest6.9 KB
Original Source

For the complete documentation index, see llms.txt. This page is also available as Markdown.

The Anytype Agents' Skill is an open-source toolkit that gives AI assistants a safe way to read, search, and modify Objects in your Anytype Channels. Drop it into Claude Code, Cursor, Gemini CLI, GitHub Copilot, or any other agent-capable tool, and the agent can run scripts against your Anytype data — programmatically — to handle bulk edits, transformations, and repetitive tasks you'd rather not do by hand.

The repository is on GitHub: github.com/anyproto/anytype-agents-skill.


Anytype already exposes a Local API for direct integration. The Skill is a layer above that — it bundles the API into ready-made functions an AI agent can use without you having to teach it the protocol.

If you've ever thought "I wish I could just describe what I want to do to my notes and have it happen," this is the bridge. You describe the task in plain language, the agent uses the Skill to translate that into the correct Anytype operations, and the work gets done.

Common use cases:

Bulk Property updates — "Set all Tasks in the 'Q1 Planning' Collection to Status: In Progress"

Data transformations — "Find all Notes tagged 'meeting' from last quarter and create a Collection summarizing them"

Migration and cleanup — "Rename every Object containing 'TODO' in its title to remove that prefix"

Reporting — "List all Objects modified by me this month, grouped by Type"

Cross-Channel operations — "Copy this Type definition from my Personal Channel to my Team Channel"

How it works

The Skill provides a lightweight, isolated JavaScript runtime. When the agent decides to do something to your Anytype data, it writes a short JavaScript script using the Skill's high-level methods, then runs it in the sandbox. The script reads or writes through your local Anytype Local API.

Around 30 high-level methods are exposed, covering:

Reading Objects — get Object by ID, list Objects by Type, search across Channels

Creating Objects — add a new Object with Type, Properties, and content

Updating Objects — set Property values, change Type, edit content blocks

Searching — full-text search, filter by Property, scope to a Channel

Working with Types and Properties — list available Types, create new ones, manage Properties

Collections and Queries — add/remove Objects from a Collection, query with filters

The runtime is isolated — the script only has access to the Anytype Skill's methods, not to your filesystem or network. This means you can run AI-generated scripts without worrying about them doing something destructive outside Anytype itself.

(Inside Anytype, of course, the script can change anything the API allows. See the Safety section below.)

Setup

Prerequisites

Anytype installed and running on the same device

A Local API key generated in Vault Settings > API Keys

An AI agent that supports tool use (Claude Code, Cursor, Gemini CLI, GitHub Copilot, etc.)

Install the Skill

The exact installation steps depend on which agent you're using. Generally:

Clone or download the Skill from github.com/anyproto/anytype-agents-skill.

Configure your agent to load the Skill (each agent has its own way to register tools — see the agent's docs).

Provide your Anytype API key when prompted.

The Skill's repository includes per-agent setup guides for the most common tools.

Verify it's working

Ask the agent something simple, like:

List all the Object Types in my Personal Channel.

If the Skill is connected, the agent runs a method like listTypes() against your Local API and reports back. If it isn't, you'll see an error or the agent will fall back to general-knowledge guesswork.

Example workflows

Bulk update

Set the Status of every Task in the "Sprint 14" Collection to "Done".

The agent writes a short script that:

Finds the Collection by name

Lists all Objects inside

Filters to Type: Task

Updates the Status Property of each one

You see the script before it runs (in most agents) and can approve or reject it.

Find and report

How many Notes did I create this month, and which Tags do they use?

The agent:

Queries Objects of Type: Note

Filters by creation date

Aggregates Tag values

Returns a report

No data is changed.

Transform and migrate

For every Book Object in my Reading channel, create a corresponding Review Object linked to it.

The agent:

Lists Books

For each, creates a new Review Object with a relation back to the Book

Reports what it did

Safety

What the Skill can do

Anything the Local API can do. This includes creating, updating, and deleting Objects, modifying Types and Properties, and editing block content.

What the Skill can't do

Access files on your computer outside Anytype

Make network requests outside the Local API

See or modify other Channels you haven't given the agent access to (more accurately: the agent can only act on Channels accessible through the API key you provided)

Bypass Channel permissions — if your role in a Channel is Viewer, the Skill can only read

Recommendations

Review scripts before running them. Most agents show you what they're about to execute. Read it. A "delete all Objects matching X" script run by mistake is hard to recover from.

Use a separate API key for agent work. If you ever want to revoke the agent's access, you can delete the key in Vault Settings > API Keys without affecting your other integrations.

Test on a small scope first. Before running a bulk operation on hundreds of Objects, ask the agent to do it on five and check the result.

Where to learn more

Anytype Agents' Skill on GitHub — full method reference, examples, per-agent setup

Local API — the underlying interface

API Keys — managing keys in Vault Settings

PreviousRaycast Extension (macOS)NextSync & Backup

Last updated 3 hours ago

Was this helpful?