Skip to main content
Glama
arrivets

Arkiv MCP Server

by arrivets

Servidor MCP de Arkiv

Un servidor de Model Context Protocol (MCP) que expone las capacidades de consulta de la cadena de bases de datos de Arkiv a agentes y aplicaciones de IA.

Inicio rápido

1. Compilar

cd arkiv-mcp
npm install
npm run build

2. Añadir a Claude Code

Ejecuta esto desde el directorio arkiv-mcp:

claude mcp add arkiv -- node $(pwd)/dist/index.js

O añádelo manualmente a ~/.claude/settings.json:

{
  "mcpServers": {
    "arkiv": {
      "command": "node",
      "args": ["/absolute/path/to/arkiv-mcp/dist/index.js"]
    }
  }
}

Para Claude Desktop, añade el mismo bloque a ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) o %APPDATA%\Claude\claude_desktop_config.json (Windows).

3. Consultar la red de pruebas (testnet) de Kaolin

Una vez conectado, la herramienta query_entities estará disponible. Ejemplos de prompts:

  • "Query all entities on Arkiv"

  • "Find all Arkiv entities where type = "post" and score > 10"

  • "Show me entities owned by 0x1234... on the Arkiv testnet"

  • "Get the first 5 entities matching status = "active", then paginate"


Related MCP server: TextQL MCP Server

Características

  • Consulta entidades de las cadenas de bases de datos de Arkiv usando una expresión de filtro similar a SQL

  • Sintaxis completa de arkiv_query: comparaciones, operadores lógicos, coincidencia de glob, atributos sintéticos

  • Soporte de paginación con cursor

  • Campos de retorno configurables (atributos, metadatos, carga útil)

  • Predeterminado a la red de pruebas de Kaolin

Instalación

cd arkiv-mcp
npm install
npm run build

# Or use tsx for development
npm run dev

Uso

Iniciar el servidor

# Using default Kaolin testnet
npm start

# With custom node URL
npm start -- --node-url https://your-arkiv-node.rpc

# Or with tsx for development
npm run dev -- --node-url https://your-arkiv-node.rpc

Variables de entorno

Variable

Descripción

Requerido

ARKIV_NODE_URL

URL RPC del nodo de Arkiv

No (predeterminado a la red de pruebas de Kaolin)

Opciones de línea de comandos

Opción

Descripción

Predeterminado

--node-url <url>

URL RPC del nodo de Arkiv

Red de pruebas de Kaolin

--help, -h

Mostrar ayuda

-

Herramienta MCP

query_entities

Consulta entidades de una cadena de base de datos de Arkiv.

Parámetros

Parámetro

Tipo

Descripción

Predeterminado

filter

string

Expresión de filtro (ver sintaxis abajo)

$all

limit

number

Número máximo de entidades a devolver (máx 200)

-

cursor

string

Cursor de paginación de una respuesta anterior

-

withAttributes

boolean

Incluir atributos en los resultados

true

withMetadata

boolean

Incluir metadatos (propietario, creador, caducidad) en los resultados

true

withPayload

boolean

Incluir carga útil en los resultados (codificada en base64)

true

validAtBlock

number

Consultar el estado en un número de bloque específico

-

Sintaxis de filtro

El parámetro filter utiliza el lenguaje de expresión arkiv_query:

Operador

Descripción

Ejemplo

=

Igualdad

status = "active"

!=

No igual

status != "deleted"

>, >=, <, <=

Rango numérico

score > 100

&&

AND lógico

type = "post" && score > 50

||

OR lógico

status = "active" || status = "pending"

!

Negación

!(status = "deleted")

~

Coincidencia de glob

name ~ "test*"

!~

Glob negado

name !~ "draft*"

Atributos sintéticos (prefijados con $) :

Atributo

Descripción

$all

Coincidir con todas las entidades

$owner

Dirección del propietario actual

$creator

Dirección del creador original (inmutable)

$key

Clave de la entidad

Ejemplos de filtros

# All entities
$all

# By entity key
$key = "0xabc123..."

# By owner or creator
$owner = "0x1234567890abcdef..."
$creator = "0x1234567890abcdef..."

# Attribute equality
status = "active"
type = "post"

# Numeric range
score > 100
price >= 50 && price <= 200

# Compound
project = "myapp" && type = "post" && score > 10

# Glob matching
name ~ "draft*"
!(status = "deleted")

Formato de respuesta

{
  "entities": [
    {
      "key": "0x...",
      "owner": "0x...",
      "creator": "0x...",
      "createdAtBlock": "12345",
      "lastModifiedAtBlock": "12350",
      "expiresAtBlock": "99999",
      "contentType": "application/json",
      "payload": "<base64-encoded bytes>",
      "attributes": [
        { "key": "type", "value": "post" },
        { "key": "score", "value": 42 }
      ]
    }
  ],
  "cursor": "0x2a",
  "blockNumber": "12350",
  "count": 1
}

Pagina pasando el cursor devuelto como el parámetro cursor en la siguiente llamada. Cuando el cursor está ausente, no hay más resultados.

Desarrollo

El servidor utiliza:

Estructura del proyecto

arkiv-mcp/
├── src/
│   └── index.ts          # Main server implementation
├── package.json
├── tsconfig.json
└── README.md

Licencia

MIT

Available Tools

1 tool
query_entitiesA

Query entities from an Arkiv database chain using a filter expression. The filter uses a SQL-like syntax: comparisons (=, !=, <, >, <=, >=), logical operators (&& and ||), negation (!), and glob matching (~). Special attributes: $all (match everything), $owner (current owner address), $creator (original creator address, immutable), $key (entity key). Examples: '$all', 'status = "active"', 'score > 100', 'project = "myapp" && status = "active"', '$owner = "0x1234..."', 'name ~ "test*"'

ParametersJSON Schema
NameRequiredDescriptionDefault
filterNoFilter expression. Defaults to "$all" if omitted. Examples: 'status = "active"', 'score > 100 && type = "post"', '$owner = "0xAbc..."', '$creator = "0xDef..."', 'name ~ "prefix*"'
limitNoMaximum number of entities to return (max 200)
cursorNoPagination cursor returned by a previous query
withAttributesNoInclude attributes in results (default: true)
withMetadataNoInclude metadata (owner, creator, expiry) in results (default: true)
withPayloadNoInclude payload in results as base64 (default: true)
validAtBlockNoQuery state at a specific block number

TDQS

A4.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden. It explains the filter syntax and special attributes but does not disclose performance implications, rate limits, or confirm that it is read-only. Schema covers some aspects (e.g., limit), but behavioral context is lacking.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, well-structured paragraph that front-loads the core purpose, then details the filter syntax, special attributes, and examples. Every sentence adds value without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, the description does not explain return values explicitly, but the tool name and parameters imply entities with requested fields. Pagination cursor is mentioned in schema but not explained in description. Overall, it is fairly complete for a query tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so baseline is 3. The description adds meaningful context for the 'filter' parameter by detailing the syntax and special attributes ($all, $owner, etc.), which goes beyond the schema. Other parameters are not enhanced, but the main parameter benefits significantly.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states that the tool queries entities from an Arkiv database chain using a filter expression, with specific SQL-like syntax and special attributes. It is a specific verb-resource pair, and there are no sibling tools to distinguish against.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides examples and syntax details that imply when to use the tool, but does not explicitly state when not to use or mention alternatives. Since there are no sibling tools, the lack of exclusion is less critical.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 1 tool updatev1.0.0
    • First observedquery_entities

TDQS

A3.9/5.0

Scored across 1 tool

Disambiguation5/5

Only one tool exists, so there is no risk of confusion between tools. Perfect disambiguation.

Naming Consistency5/5

With a single tool, there are no naming inconsistencies. The name 'query_entities' follows a clear verb_noun pattern.

Tool Count1/5

A single tool is insufficient for a database server; even if it's query-only, missing CRUD operations severely limits functionality. Extreme mismatch.

Completeness2/5

The server only offers query functionality, omitting essential operations like create, update, or delete. Significant gaps for typical database interaction.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers