api-discovery

Resolve Maven artifact source paths for direct API inspection.

2|Updated May 28, 2021
One-click install
npx skills add https://github.com/SpineEventEngine/validation --skill api-discovery-spineeventengine
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-discovery
Source: https://github.com/SpineEventEngine/validation/tree/main/.agents/skills/api-discovery
Command: npx skills add https://github.com/SpineEventEngine/validation --skill api-discovery-spineeventengine

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

It eliminates slow, noisy, and repeated extraction of Gradle cache JARs by resolving a Maven artifact’s on-disk source location for direct inspection.

Core Features & Use Cases

  • Artifact source resolution: Finds the absolute local path for a specified Maven artifact (optionally including group, artifact, and version).
  • Fast inspection workflow: Enables direct Grep/Read/Glob against the resolved path to check public APIs, KDoc/comments, and implementation details.
  • Staleness and safety guardrails: Detects mismatches between declared versions and local siblings, optionally refreshes safely, and blocks fallback unzip workarounds.
  • Cache bootstrap handling: Guides first-run behavior when the shared extraction cache directory is not initialized.

Quick Start

Run the command .agents/scripts/api-discovery/discover io.spine:spine-base and then use the printed stdout path with Grep or Read to inspect the source immediately.

Frequently Asked Questions about api-discovery

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I inspect Maven artifact source code without unzipping Gradle cache JARs?

To inspect Maven artifact source code without unzipping Gradle cache JARs, run the discover script to resolve the artifact's on-disk absolute path. You can then use Grep, Read, or Glob directly against that path to check APIs and implementation details.

What is the fastest way to locate a Maven artifact's local source path for API analysis?

The fastest way to locate a Maven artifact's source path for API analysis is running the discover script with the artifact coordinates. It outputs the absolute local path to stdout, enabling immediate source inspection without slow extraction processes.

Can I use Grep and Read to check type definitions in Spine sibling sources directly from the cache?

Yes, you can use Grep and Read to check type definitions in Spine sibling sources directly from the cache. The discover script resolves the absolute source path, allowing immediate file reading and pattern matching against KDoc and method signatures.

Why does Maven artifact discovery fail when the shared extraction cache directory is not initialized?

Maven artifact discovery requires a initialized shared extraction cache directory for first-run bootstrap. If the directory is missing, the discovery script provides guidance to initialize it, ensuring safe access to local sibling sources without fallback unzip workarounds.

What should I do if declared Maven artifact versions mismatch local siblings during source inspection?

When declared Maven artifact versions mismatch local siblings during source inspection, the discovery script detects the staleness and optionally refreshes safely. It enforces safety guardrails by blocking fallback unzip extraction workarounds when resolution fails.