Skip to content

Specifications

This section collects machine-readable examples for the Literature Review Assistant reference scenario.

These files are non-normative demo artifacts unless a linked standard says otherwise. They are checked to keep the examples parseable, linked, and internally consistent.

The local runnable demo uses these artifacts as its contract source and patches only local URLs at runtime.

Demo Artifacts

ArtifactPurposeUsed by
agent-card.jsonPublic Agent Card for the Literature Review AssistantDiscovery, Agent Card
agent-registry.yamlNon-normative registry entry with approved domain, current Agent Card version, trust level, allowed protocols, scopes, and review metadataAgent Registry, Trust Model
openapi.yamlOpenAPI 3.1 contract for registry lookup, document search, review drafts, and local trace inspectionAPIs
oidc-client.example.jsonOIDC/OAuth2 client and scope modelIdentity
mcp-tools.jsonMCP tools/list example for document toolsMCP, Agent Protocols
a2a-message-send.jsonA2A message/send example requestA2A, Agent Protocols
memory.yamlVector and graph memory configurationMemory
model-routing.yamlModel gateway routing policyModels
application-workflow.yamlEnd-to-end application workflowApplications, End-to-End Demo
evaluation-scenarios.yamlEvaluation scenarios for agent behavior, auth failures, tool failures, and stale discovery metadataOperations and Evaluation

Artifact-to-Layer Map

Stack layerArtifact evidenceWhy it exists
Discoveryagent-card.json, agent-registry.yamlPublish self-description and local trust approval
Identityoidc-client.example.jsonModel delegated scopes, claims, audience, and token handling
APIsopenapi.yamlDefine deterministic registry, document, draft, and trace operations
Agent Protocolsmcp-tools.json, a2a-message-send.jsonShow tool access and delegated agent work
Memorymemory.yamlModel vector retrieval, graph expansion, and visibility filters
Modelsmodel-routing.yamlDescribe provider-neutral routing and usage capture
Applicationsapplication-workflow.yaml, evaluation-scenarios.yamlCompose the workflow and verify expected behavior

Runnable Demo

Run the Local Demo shows how the FastAPI service exposes the Agent Card, registry entry, OpenAPI contract, MCP tools, A2A endpoint, scoped dev tokens, document search, trace output, and review draft creation from the same reference scenario.

Validation

The published examples are checked for:

  • required demo files exist
  • JSON and YAML files parse
  • demo files validate against local schemas in specs/schemas/
  • MCP nested input and output schemas compile
  • openapi.yaml passes Redocly lint
  • docs links to /specs/demo/... point at real files

Schema Scope

Local schemas in specs/schemas/ validate the reference examples. They are intentionally not full A2A, MCP, OAuth2, OpenID Connect, OpenAPI, or model-provider conformance schemas.

Page created by Dr. C. Klukas