@bluefly/openstandardagents 0.2.4

package/dist/types/openapi-extensions.d.ts

@@ -0,0 +1,164 @@
+/**
+ * OSSA OpenAPI/Swagger Specification Extensions
+ * TypeScript type definitions for OSSA-specific OpenAPI extensions
+ */
+/**
+ * Root-level extension: Comprehensive OSSA agent metadata
+ */
+export interface XOssaMetadata {
+    version: string;
+    compliance?: {
+        level: 'basic' | 'standard' | 'advanced' | 'enterprise';
+        frameworks?: string[];
+    };
+    governance?: {
+        approved?: boolean;
+        approvedBy?: string;
+        approvalDate?: string;
+    };
+    security?: {
+        classification?: 'public' | 'internal' | 'confidential' | 'restricted';
+        authentication?: 'required' | 'optional' | 'none';
+        encryption?: string;
+    };
+    observability?: {
+        tracing?: boolean;
+        metrics?: boolean;
+        logging?: boolean;
+    };
+}
+/**
+ * Root-level extension: Core OSSA compliance information
+ */
+export interface XOssa {
+    version: string;
+    agent: {
+        id: string;
+        type: 'orchestrator' | 'worker' | 'specialist' | 'critic' | 'judge' | 'monitor' | 'gateway' | 'governor' | 'integrator' | 'voice';
+        compliance?: {
+            standards?: string[];
+            validated?: boolean;
+            validatedAt?: string;
+        };
+    };
+}
+/**
+ * Root-level extension: Agent-specific capabilities and configuration
+ */
+export interface XAgent {
+    capabilities?: string[];
+    tools?: string[];
+    environment?: Record<string, unknown>;
+    rules?: string[];
+}
+/**
+ * Operation-level extension: Links operation to agent capability
+ */
+export type XOssaCapability = string | {
+    name: string;
+    description?: string;
+    inputSchema?: Record<string, unknown>;
+    outputSchema?: Record<string, unknown>;
+};
+/**
+ * Operation-level extension: Defines autonomy level for operation
+ */
+export interface XOssaAutonomy {
+    level: 'supervised' | 'autonomous' | 'semi-autonomous';
+    approval_required?: boolean;
+    allowed_actions?: string[];
+    blocked_actions?: string[];
+}
+/**
+ * Operation-level extension: Cost, token, and resource constraints
+ */
+export interface XOssaConstraints {
+    cost?: {
+        maxTokensPerDay?: number;
+        maxTokensPerRequest?: number;
+        maxCostPerDay?: number;
+        currency?: string;
+    };
+    performance?: {
+        maxLatencySeconds?: number;
+        maxConcurrentRequests?: number;
+    };
+    time?: {
+        maxExecutionTime?: number;
+    };
+}
+/**
+ * Operation-level extension: MCP servers or tools required
+ */
+export interface XOssaTool {
+    type: 'mcp' | 'http' | 'custom';
+    server: string;
+    namespace?: string;
+    capabilities?: string[];
+}
+export type XOssaTools = XOssaTool[];
+/**
+ * Operation-level extension: LLM configuration override
+ */
+export interface XOssaLlm {
+    provider: 'openai' | 'anthropic' | 'google' | 'azure' | 'custom';
+    model: string;
+    temperature?: number;
+    maxTokens?: number;
+}
+/**
+ * Parameter extension: Header parameter for agent identification
+ */
+export interface XOssaAgentId {
+    name?: string;
+    description?: string;
+    required?: boolean;
+}
+/**
+ * Parameter extension: Header parameter for OSSA version
+ */
+export interface XOssaVersion {
+    name?: string;
+    description?: string;
+    required?: boolean;
+}
+/**
+ * Schema extension: Capability schema metadata
+ */
+export interface XOssaCapabilitySchema {
+    capabilityName: string;
+    input?: boolean;
+    output?: boolean;
+    validation?: {
+        required?: boolean;
+        strict?: boolean;
+    };
+}
+/**
+ * OpenAPI 3.1 spec with OSSA extensions at root level
+ */
+export interface OpenAPISpecWithOssaExtensions {
+    'x-ossa-metadata'?: XOssaMetadata;
+    'x-ossa'?: XOssa;
+    'x-agent'?: XAgent;
+    [key: string]: unknown;
+}
+/**
+ * OpenAPI operation with OSSA extensions
+ */
+export interface OpenAPIOperationWithOssaExtensions {
+    'x-ossa-capability'?: XOssaCapability;
+    'x-ossa-autonomy'?: XOssaAutonomy;
+    'x-ossa-constraints'?: XOssaConstraints;
+    'x-ossa-tools'?: XOssaTools;
+    'x-ossa-llm'?: XOssaLlm;
+    [key: string]: unknown;
+}
+/**
+ * OpenAPI schema with OSSA extensions
+ */
+export interface OpenAPISchemaWithOssaExtensions {
+    'x-ossa-capability-schema'?: XOssaCapabilitySchema;
+    [key: string]: unknown;
+}
+//# sourceMappingURL=openapi-extensions.d.ts.map

package/dist/types/openapi-extensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-extensions.d.ts","sourceRoot":"","sources":["../../src/types/openapi-extensions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE;QACX,KAAK,EAAE,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,YAAY,CAAC;QACxD,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;KACvB,CAAC;IACF,UAAU,CAAC,EAAE;QACX,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,cAAc,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,cAAc,GAAG,YAAY,CAAC;QACvE,cAAc,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC;QAClD,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,aAAa,CAAC,EAAE;QACd,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE;QACL,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EACA,cAAc,GACd,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,OAAO,GACP,SAAS,GACT,SAAS,GACT,UAAU,GACV,YAAY,GACZ,OAAO,CAAC;QACZ,UAAU,CAAC,EAAE;YACX,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;YACrB,SAAS,CAAC,EAAE,OAAO,CAAC;YACpB,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,MAAM,GACN;IACE,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC,CAAC;AAEN;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,YAAY,GAAG,YAAY,GAAG,iBAAiB,CAAC;IACvD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE;QACL,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,WAAW,CAAC,EAAE;QACZ,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAC;KAChC,CAAC;IACF,IAAI,CAAC,EAAE;QACL,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,MAAM,MAAM,UAAU,GAAG,SAAS,EAAE,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IACjE,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE;QACX,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,iBAAiB,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,mBAAmB,CAAC,EAAE,eAAe,CAAC;IACtC,iBAAiB,CAAC,EAAE,aAAa,CAAC;IAClC,oBAAoB,CAAC,EAAE,gBAAgB,CAAC;IACxC,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,0BAA0B,CAAC,EAAE,qBAAqB,CAAC;IACnD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB"}

package/dist/types/openapi-extensions.js

@@ -0,0 +1,6 @@
+/**
+ * OSSA OpenAPI/Swagger Specification Extensions
+ * TypeScript type definitions for OSSA-specific OpenAPI extensions
+ */
+export {};
+//# sourceMappingURL=openapi-extensions.js.map

package/dist/types/openapi-extensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-extensions.js","sourceRoot":"","sources":["../../src/types/openapi-extensions.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/docs/OSSA-COMPLIANT-BADGE.md

@@ -0,0 +1,248 @@
+# OSSA Compliant Badge
+
+Display the **OSSA Compliant** badge in your project to show that your AI agent follows the Open Standard for AI Agents (OSSA) specification.
+
+---
+
+## Badge Options
+
+### Markdown
+
+```markdown
+[![OSSA Compliant](https://img.shields.io/badge/OSSA-Compliant-00B8D4.svg)](https://gitlab.bluefly.io/llm/openapi-ai-agents-standard)
+```
+
+**Result**:
+[![OSSA Compliant](https://img.shields.io/badge/OSSA-Compliant-00B8D4.svg)](https://gitlab.bluefly.io/llm/openapi-ai-agents-standard)
+
+### HTML
+
+```html
+<a href="https://gitlab.bluefly.io/llm/openapi-ai-agents-standard">
+  <img src="https://img.shields.io/badge/OSSA-Compliant-00B8D4.svg" alt="OSSA Compliant">
+</a>
+```
+
+### reStructuredText
+
+```rst
+.. image:: https://img.shields.io/badge/OSSA-Compliant-00B8D4.svg
+   :target: https://gitlab.bluefly.io/llm/openapi-ai-agents-standard
+   :alt: OSSA Compliant
+```
+
+---
+
+## Compliance Requirements
+
+To display the OSSA Compliant badge, your project must:
+
+### Required
+
+1. **Valid OSSA Manifest** - Your agent must have a valid `.ossa.yaml` manifest
+2. **Schema Validation** - Manifest must pass `ossa validate` without errors
+3. **Semantic Versioning** - Agent version follows semver (e.g., `1.0.0`)
+4. **Required Fields** - All required OSSA fields must be present
+
+### Recommended
+
+1. **Examples** - Provide example manifests showing usage
+2. **Documentation** - Document your agent's capabilities and usage
+3. **Testing** - Include tests that validate your OSSA manifest
+4. **CI/CD** - Automate OSSA validation in your pipeline
+
+---
+
+## Verification
+
+### Manual Verification
+
+```bash
+# Install OSSA CLI
+npm install -g @bluefly/open-standards-scalable-agents
+
+# Validate your manifest
+ossa validate path/to/your-agent.ossa.yaml
+```
+
+### Automated Verification (CI/CD)
+
+#### GitLab CI
+
+```yaml
+ossa-validation:
+  stage: test
+  image: node:20-alpine
+  script:
+    - npm install -g @bluefly/open-standards-scalable-agents
+    - ossa validate agents/*.ossa.yaml
+```
+
+#### GitHub Actions
+
+```yaml
+name: OSSA Validation
+on: [push, pull_request]
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+      - run: npm install -g @bluefly/open-standards-scalable-agents
+      - run: ossa validate agents/*.ossa.yaml
+```
+
+---
+
+## Compliance Levels
+
+### Level 1: Basic Compliance
+
+- Valid OSSA manifest
+- Required fields present
+- Passes schema validation
+
+### Level 2: Standard Compliance
+
+- Level 1 requirements
+- Best practices followed (descriptions, examples)
+- Semantic versioning
+- At least one capability defined
+
+### Level 3: Advanced Compliance
+
+- Level 2 requirements
+- Platform extensions configured
+- Observability enabled
+- Resource constraints defined
+- Security considerations documented
+
+---
+
+## OSSA Certified Projects
+
+Projects that have achieved OSSA compliance:
+
+| Project | Level | Version | Link |
+|---------|-------|---------|------|
+| Agent Buildkit | Advanced | v0.2.3 | [GitLab](https://gitlab.bluefly.io/llm/npm/agent-buildkit) |
+| Agent Studio | Advanced | v0.2.3 | [GitLab](https://gitlab.bluefly.io/llm/demos/llm-platform-demo) |
+| KAgent | Advanced | v0.2.3 | [GitLab](https://gitlab.bluefly.io/llm/npm/kagent) |
+
+**Add your project**: Submit a merge request to update this table!
+
+---
+
+## Example Implementation
+
+### Minimal OSSA Manifest
+
+```yaml
+apiVersion: ossa/v0.2.3
+kind: Agent
+
+metadata:
+  name: my-agent
+  version: 1.0.0
+  description: A simple OSSA-compliant agent
+
+spec:
+  role: |
+    You are a helpful assistant that processes data.
+
+  llm:
+    provider: openai
+    model: gpt-4
+
+  tools:
+    - type: function
+      name: process_data
+      description: Process incoming data
+```
+
+### With Platform Extensions
+
+```yaml
+apiVersion: ossa/v0.2.3
+kind: Agent
+
+metadata:
+  name: my-agent
+  version: 1.0.0
+  description: An advanced OSSA-compliant agent
+  labels:
+    environment: production
+    team: ai-engineering
+
+spec:
+  role: |
+    You are a production-ready agent with observability.
+
+  llm:
+    provider: openai
+    model: gpt-4
+    temperature: 0.7
+
+  tools:
+    - type: function
+      name: analyze_data
+      description: Analyze data and generate insights
+
+  observability:
+    tracing:
+      enabled: true
+      exporter: otlp
+    metrics:
+      enabled: true
+      exporter: prometheus
+
+extensions:
+  buildkit:
+    deployment:
+      replicas: 3
+      autoscaling: true
+```
+
+---
+
+## FAQ
+
+### Q: Can I use the badge if my agent partially implements OSSA?
+
+**A**: The badge should only be used if your agent has a **valid, complete OSSA manifest** that passes validation. Partial implementations should work toward full compliance before displaying the badge.
+
+### Q: Do I need to register my project?
+
+**A**: No registration required! OSSA is an open standard. Simply ensure your manifest validates and add the badge.
+
+### Q: What if my agent uses a custom runtime?
+
+**A**: OSSA supports custom runtimes! Use platform extensions to define your custom runtime while maintaining OSSA compliance.
+
+### Q: Can I modify the badge design?
+
+**A**: The official badge design helps maintain consistency across the ecosystem. However, you can customize colors for your specific needs while keeping the "OSSA Compliant" text visible.
+
+---
+
+## Resources
+
+- **OSSA Specification**: [spec/v0.2.3/](../spec/v0.2.3/)
+- **Examples**: [examples/](../examples/)
+- **CLI Documentation**: [docs/cli/](./cli/)
+- **Contributing**: [CONTRIBUTING.md](../CONTRIBUTING.md)
+- **GitLab Repository**: https://gitlab.bluefly.io/llm/openapi-ai-agents-standard
+- **GitHub Mirror**: https://github.com/BlueflyCollective/OSSA
+
+---
+
+**Questions?** Open an issue on [GitLab](https://gitlab.bluefly.io/llm/openapi-ai-agents-standard/-/issues)
+
+**Want to contribute?** See [CONTRIBUTING.md](../CONTRIBUTING.md)
+
+---
+
+*OSSA: The OpenAPI for AI Agents*

package/docs/README.md

@@ -0,0 +1,31 @@
+# OSSA Documentation
+
+## Core Documentation
+
+- **[Getting Started](getting-started.md)** - Quick start guide for OSSA
+- **[OpenAPI Extensions](openapi-extensions.md)** - How OSSA extends OpenAPI/Swagger for AI agents
+- **[Migration Guide](migration/)** - Upgrading from v0.1.x to v1.0
+- **[Specification](../spec/)** - OSSA 1.0 JSON Schema
+- **[Examples](../examples/)** - Reference implementations
+
+## Additional Resources
+
+For comprehensive documentation, guides, and architecture details, visit:
+
+**[OSSA GitLab Wiki](https://gitlab.bluefly.io/llm/openapi-ai-agents-standard/-/wikis/home)**
+
+The Wiki contains:
+- Architecture guides
+- Deployment strategies
+- Integration tutorials
+- Best practices
+- Community guidelines
+- Contributing guidelines
+
+## Quick Links
+
+- **Specification**: [spec/ossa-1.0.schema.json](../spec/ossa-1.0.schema.json)
+- **npm Package**: [@bluefly/open-standards-scalable-agents](https://www.npmjs.com/package/@bluefly/open-standards-scalable-agents)
+- **GitLab Repository**: [llm/openapi-ai-agents-standard](https://gitlab.bluefly.io/llm/openapi-ai-agents-standard)
+- **Issues**: [GitLab Issues](https://gitlab.bluefly.io/llm/openapi-ai-agents-standard/-/issues)
+