Skip to main content
Glama
deenesjakoruzh
arrivets

Arkiv MCP Server

by arrivets
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

Arkiv MCP-Server

Ein Model Context Protocol (MCP)-Server, der die Abfragefunktionen von Arkiv-Datenbankketten für KI-Agenten und Anwendungen bereitstellt.

Schnellstart

1. Build

cd arkiv-mcp
npm install
npm run build

2. Zu Claude Code hinzufügen

Führen Sie dies im arkiv-mcp-Verzeichnis aus:

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

Oder fügen Sie es manuell zu ~/.claude/settings.json hinzu:

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

Für Claude Desktop fügen Sie denselben Block zu ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) oder %APPDATA%\Claude\claude_desktop_config.json (Windows) hinzu.

3. Das Kaolin-Testnetz abfragen

Sobald die Verbindung hergestellt ist, steht das Tool query_entities zur Verfügung. Beispiel-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

Funktionen

  • Abfrage von Entitäten aus Arkiv-Datenbankketten mittels eines SQL-ähnlichen Filterausdrucks

  • Vollständige arkiv_query-Syntax: Vergleiche, logische Operatoren, Glob-Matching, synthetische Attribute

  • Paginierungsunterstützung mit Cursor

  • Konfigurierbare Rückgabefelder (Attribute, Metadaten, Payload)

  • Standardmäßig auf das Kaolin-Testnetz eingestellt

Installation

cd arkiv-mcp
npm install
npm run build

# Or use tsx for development
npm run dev

Verwendung

Server starten

# 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

Umgebungsvariablen

Variable

Beschreibung

Erforderlich

ARKIV_NODE_URL

Arkiv-Knoten RPC-URL

Nein (Standard: Kaolin-Testnetz)

Befehlszeilenoptionen

Option

Beschreibung

Standard

--node-url <url>

Arkiv-Knoten RPC-URL

Kaolin-Testnetz

--help, -h

Hilfe anzeigen

-

MCP-Tool

query_entities

Fragt Entitäten aus einer Arkiv-Datenbankkette ab.

Parameter

Parameter

Typ

Beschreibung

Standard

filter

string

Filterausdruck (siehe Syntax unten)

$all

limit

number

Maximale Anzahl der zurückzugebenden Entitäten (max. 200)

-

cursor

string

Paginierungs-Cursor aus einer vorherigen Antwort

-

withAttributes

boolean

Attribute in den Ergebnissen einschließen

true

withMetadata

boolean

Metadaten (Besitzer, Ersteller, Ablaufdatum) in den Ergebnissen einschließen

true

withPayload

boolean

Payload in den Ergebnissen einschließen (base64-kodiert)

true

validAtBlock

number

Abfragestatus bei einer bestimmten Blocknummer

-

Filter-Syntax

Der filter-Parameter verwendet die arkiv_query-Ausdruckssprache:

Operator

Beschreibung

Beispiel

=

Gleichheit

status = "active"

!=

Ungleichheit

status != "deleted"

>, >=, <, <=

Numerischer Bereich

score > 100

&&

Logisches UND

type = "post" && score > 50

||

Logisches ODER

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

!

Negation

!(status = "deleted")

~

Glob-Match

name ~ "test*"

!~

Negierter Glob

name !~ "draft*"

Synthetische Attribute (mit $ als Präfix):

Attribut

Beschreibung

$all

Alle Entitäten abgleichen

$owner

Aktuelle Besitzeradresse

$creator

Ursprüngliche Erstelleradresse (unveränderlich)

$key

Entitätsschlüssel

Filter-Beispiele

# 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")

Antwortformat

{
  "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
}

Paginiere, indem du den zurückgegebenen cursor als cursor-Parameter im nächsten Aufruf übergibst. Wenn kein cursor vorhanden ist, gibt es keine weiteren Ergebnisse.

Entwicklung

Der Server verwendet:

Projektstruktur

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

Lizenz

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
Deploy Server
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

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

Resources

Related MCP Connectors

Related MCP Servers