DEVELOPER PORTAL // MACHINE INTERFACES & CLI

Omnifex Developer Documentation & Agent Tools

Omnifex provides open, machine-accessible interfaces including a native Model Context Protocol (MCP) server, an official CLI tool (npx omnifex), path-versioned REST API endpoints (/api/v1/), and comprehensive machine-readable indices for autonomous agents and engineering teams.

001 / OFFICIAL CLI TOOL

Official CLI Tool: omnifex

The official Omnifex CLI lets developers and autonomous agents script interactions, verify service health, and run local stdio Model Context Protocol sessions without writing API integration boilerplate.

QUICK INVOCATION (NPX)
# Run without installation
npx omnifex --help

# Query capabilities and research initiatives
npx omnifex info

# Run live endpoint diagnostics
npx omnifex status
AGENT SCRIPTING & STDIO MCP
# Submit structured inquiry via CLI
npx omnifex inquire \
  --name "Research Agent" \
  --email "agent@lab.org" \
  --intent software \
  --message "Automated dataset verification pipeline"

# Start stdio MCP bridge for Claude Desktop / Cursor
npx omnifex mcp
002 / DISCOVERY INDEX

Machine-Readable Resources

MCP SERVER ENDPOINT

/mcp & /api/v1/mcp

Streamable HTTP & JSON-RPC 2.0 transport exposing native tools and resources.

Inspect /mcp →
MCP MANIFEST

/.well-known/mcp.json

Standard discovery manifest for Model Context Protocol compliant agents.

View Manifest →
OPENAPI 3.1 SPEC

/openapi.json

Complete typed OpenAPI 3.1 spec covering 100% of operations with RFC 9457 errors.

View OpenAPI JSON →
LLMS INDEX

/llms.txt

Structured summary adhering to llmstxt.org with decision rubric for agents.

View llms.txt →
FULL LLM CONTEXT

/llms-full.txt

Complete technical documentation for context-window injection.

View llms-full.txt →
XML SITEMAP

/sitemap.xml

W3C standard XML index with lastmod timestamps for all canonical routes.

View Sitemap →
003 / MODEL CONTEXT PROTOCOL

MCP Tools & Exposed Resources

The Omnifex MCP server implements JSON-RPC 2.0 with full support for both tools/* and resources/* methods.

Exposed Tools (tools/list)

  • omnifex_get_company_profileRetrieve mission, values, and engineering standards.
  • omnifex_list_capabilitiesQuery Custom Software, Automation, and Research domains.
  • omnifex_list_research_initiativesInspect active research papers and Research Engine specs.
  • omnifex_submit_inquiryRegister structured inquiries directly into our intake queue.

Exposed Resources (resources/list)

  • omnifex://company/profileCompany profile, mission, values, and standards JSON.
  • omnifex://capabilities/catalogFull directory of software, automation, and research offerings.
  • omnifex://research/engine-specArchitecture specification for Omnifex Research Engine.
  • omnifex://docs/apiAPI reference and rate limit documentation in Markdown.
004 / REST API SPECIFICATION

REST Standards, Versioning & Errors

Omnifex REST endpoints follow strict agentic standards: RFC 9457 structured JSON error bodies, explicit URL path versioning, and IETF standard rate limiting headers.

1. URL Path & Header Versioning

All production endpoints are versioned under /api/v1/.... Unversioned endpoints (/api/...) route to the current stable release. Requests return X-API-Version: 1.0.0 and X-API-Lifecycle: stable.

2. RFC 9457 Structured JSON Error Format

Error responses always return application/problem+json with machine-readable error codes and resolution hints so agents never parse HTML error pages:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Problem description must be at least 10 characters.",
    "resolution": "Provide a summary of what technical challenge or project scope needs to be addressed.",
    "details": { "field": "problem", "minLength": 10 },
    "timestamp": "2026-10-25T13:30:00.000Z",
    "status": 422
  }
}

3. IETF Standard Rate Limiting Headers

Every API response includes self-throttling headers:

RateLimit-LimitMax requests permitted in the active window (e.g. 100).
RateLimit-RemainingRemaining requests in current window.
RateLimit-ResetSeconds remaining until quota resets.
Retry-AfterEmitted on HTTP 429 indicating seconds to wait.

4. Deprecation Policy

Any breaking API changes are preceded by a minimum 180-day deprecation notice period. Deprecated endpoints emit standard Deprecation: @timestamp and Sunset: date headers allowing autonomous agents to plan graceful migrations.