@lovelace-ai/elemental-api-skill

Elemental API skill documentation for AI agents. This package provides structured documentation that can be used by AI agents to understand and interact with the Elemental API.

Installation

npm install @lovelace-ai/elemental-api-skill

Usage

const { paths, files, getSkillFile } = require('@lovelace-ai/elemental-api-skill');

// Get path to main skill entry point
console.log(paths.skill);  // Path to SKILL.md

// Get path to overview
console.log(paths.overview);  // Path to overview.md

// List all skill files
console.log(files);  // ['SKILL.md', 'overview.md', 'articles.md', ...]

// Get path to a specific skill file
console.log(getSkillFile('articles'));  // Path to articles.md

Skill Files

• SKILL.md - Main entry point describing when to use this skill
• overview.md - API concepts and file guide
• articles.md - News mentions and article content
• entities.md - Entity lookup, details, and properties
• events.md - Events involving entities
• graph.md - Visual network graphs
• relationships.md - Entity connections
• sentiment.md - Sentiment analysis
• server.md - Server status and capabilities

Development

The skill files are sourced from moongoose/query/api/skill/ in the lovelace repo.

Important: Use the Cursor command instead of running these commands manually.

In Cursor, run the command defined in .cursor/commands/elemental_api_update.md which handles the full workflow: regenerating specs from Go annotations, updating skill docs, running tests, and optionally syncing/publishing packages.

# Manually sync skill files (also runs automatically before publish)
npm run sync

# Publish (syncs skill files automatically via prepublishOnly hook)
npm publish