pubfi-dsl-server-contract

Validate PubFi DSL requests and map them to deterministic OpenSearch queries.

Updated Feb 3, 2026
One-click install
npx skills add https://github.com/helixbox/pubfi-skills --skill pubfi-dsl-server-contract
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pubfi-dsl-server-contract
Source: https://github.com/helixbox/pubfi-skills/tree/main/skills/pubfi-dsl-server-contract
Command: npx skills add https://github.com/helixbox/pubfi-skills --skill pubfi-dsl-server-contract

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill defines and enforces a strict server-side contract for PubFi DSL requests, ensuring only allowed query shapes are executed and preventing unsafe inputs.

Core Features & Use Cases

  • Schema & Limits: Exposes allowed fields, aggregations, and hard limits via a dedicated schema endpoint.
  • Deterministic Execution: Maps valid DSL to a deterministic response envelope with consistent errors.
  • Endpoint Definition: Defines endpoints for /v1/dsl/schema and /v1/dsl/query, with audit logging.

Quick Start

Configure the server to use the PubFi DSL contract to validate incoming requests and return ApiEnvelope-formatted results.

Frequently Asked Questions about pubfi-dsl-server-contract

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

FAQPage Schema
How do I validate DSL requests before executing OpenSearch queries?

To validate DSL requests, you can enforce a restricted server contract that maps allowed query shapes to a deterministic OpenSearch format, preventing unsafe inputs from reaching the execution layer.

What is the best way to expose API schema and query limits for a custom DSL?

Exposing API schema and query limits is achieved through a dedicated schema endpoint, which defines allowed fields, aggregations, and hard limits for clients interacting with the custom DSL.

How do I standardize API responses and audit logs for DSL query endpoints?

Standardizing API responses involves wrapping query results in a standardized ApiEnvelope, while the server contract handles request auditing to ensure consistent error reporting and execution tracking.

Can I restrict allowed aggregations and fields in my OpenSearch query layer?

Yes, you can restrict allowed aggregations and fields by applying a deterministic DSL validation layer that enforces hard limits and blocks unauthorized query shapes before they execute.

Why do I need a deterministic server contract for DSL validation?

A deterministic server contract is needed to ensure only allowed DSL query shapes are executed against OpenSearch, mitigating the risk of unsafe inputs and guaranteeing consistent response envelopes.