Skip to content

Conversation

robertjdominguez
Copy link
Collaborator

Description

Enhanced DocsQL's API knowledge and validation protocols to handle programmatic access questions with the same rigor as CLI/metadata queries.

  • Added comprehensive API validation framework
  • Expanded context awareness for PromptQL's REST API ecosystem
  • Strengthened anti-GraphQL enforcement with specific PromptQL validation rules

Previously...

DocsQL could validate CLI commands and metadata syntax but had no structured approach for API questions:

<strict_validation_enforcement>
CRITICAL: PromptQL is NOT Hasura GraphQL Engine... NEVER show GraphQL APIs.

Before providing ANY configuration syntax, CLI commands, or code examples:
1. STOP and explicitly state "Let me validate this syntax"
2. Search documentation for exact syntax
</strict_validation_enforcement>

The bot would either wing it with API responses or awkwardly redirect everything to CLI validation.

Now...

DocsQL has a complete API validation pipeline that mirrors the existing CLI/metadata protocols:

<api_request_pattern>
When users ask about PromptQL APIs or programmatic access:
1. Identify which API they need (Execute Program, Threads, etc.)
2. Query specific API documentation using validation protocols
3. Provide exact endpoint URLs, authentication requirements
4. Always validate syntax against documentation
</api_request_pattern>

<api_validation_process description="MANDATORY for API-related questions">
1. Check API documentation: Query app.pql_docs_doc_content for pages matching:
   https://promptql.io/docs/promptql-apis/[api-name]/
2. Extract exact endpoints, authentication methods, examples
3. NEVER assume REST API patterns from other systems
</api_validation_process>

Why This Matters

The bot now treats API questions with the same validation discipline as CLI commands. Instead of making educated guesses about REST endpoints or authentication patterns, it enforces the same "validate first, answer second" approach that makes DocsQL reliable for technical queries.

Copy link

🚀 PromptQL Build Complete

Build Version: d29bf99b62
Project: docs-bot
PromptQL Playground: Open Playground

Description: PR #46: PQL: Add API prompting

@robertjdominguez robertjdominguez merged commit 055b65a into main Aug 26, 2025
1 check passed
@robertjdominguez robertjdominguez deleted the rob/pql/address-feedback-08-26-26 branch August 26, 2025 16:17
Copy link

✅ PromptQL Build Applied

Build Version: d29bf99b62
Status: Successfully applied to production
Applied at: 2025-08-26T16:17:47.880Z

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant