mirror of
https://github.com/hoshikawa2/agent_platform_oci.git
synced 2026-11-06 03:14:12 +00:00
fix: Spec Agent Runtime
This commit is contained in:
42
README.md
42
README.md
@@ -49,89 +49,91 @@ If something is not working or if you want to understand the features of the Age
|
||||
|
||||
|
||||
|
||||
[English technical specifications (SPEC-001–SPEC-020)](specs/en/README.md)
|
||||
|
||||
## SPECs / SDDs of the Agent Platform OCI
|
||||
|
||||
The Agent Platform OCI documentation is organized into numbered SPECs/SDDs, each covering an architectural, operational, or governance area of the platform. The objective is to standardize the construction, evolution, operation, and certification of enterprise agents based on the Agent Framework OCI.
|
||||
|
||||
>**/agent_platform_oci/specs**
|
||||
|
||||
### [SPEC-001 — Architecture](specs/SPEC-001-Architecture.md)
|
||||
### [SPEC-001 — Architecture](specs/en/SPEC-001-Architecture.md)
|
||||
|
||||
Defines the overall platform architecture, its main components, repository structure, logical and physical architecture, core contracts, primary flow, non-functional requirements, and acceptance criteria.
|
||||
|
||||
### [SPEC-002 — Agent Runtime](specs/SPEC-002-Agent-Runtime.md)
|
||||
### [SPEC-002 — Agent Runtime](specs/en/SPEC-002-Agent-Runtime.md)
|
||||
|
||||
Describes the conversational execution runtime for agents, including LangGraph, state management, memory, checkpoints, routing, supervisor, BusinessContext, MCP integration, RAG, events, and error handling.
|
||||
|
||||
### [SPEC-003 — Agent Gateway](specs/SPEC-003-Agent-Gateway.md)
|
||||
### [SPEC-003 — Agent Gateway](specs/en/SPEC-003-Agent-Gateway.md)
|
||||
|
||||
Specifies the gateway responsible for centralizing LLM and embedding calls, including request/response contracts, profiles, providers, OCI authentication, fallback, rate limiting, metrics, security, and observability.
|
||||
|
||||
### [SPEC-004 — MCP Gateway](specs/SPEC-004-MCP-Gateway.md)
|
||||
### [SPEC-004 — MCP Gateway](specs/en/SPEC-004-MCP-Gateway.md)
|
||||
|
||||
Defines the MCP integration model, including the tool catalog, routing, execution, authorization, caching, retries, timeouts, parameter mapping, events, metrics, and standardized tool responses.
|
||||
|
||||
### [SPEC-005 — Guardrails](specs/SPEC-005-Guardrails.md)
|
||||
### [SPEC-005 — Guardrails](specs/en/SPEC-005-Guardrails.md)
|
||||
|
||||
Describes the platform guardrail model, covering input, output, tool, RAG, and final response policies. It also defines phases, execution modes, guardrail types, LLM profiles, base codes, events, tests, and acceptance criteria.
|
||||
|
||||
### [SPEC-006 — Evals](specs/SPEC-006-Evals.md)
|
||||
### [SPEC-006 — Evals](specs/en/SPEC-006-Evals.md)
|
||||
|
||||
Defines the platform evaluation layer, including online evaluation, offline evaluation, regression testing, certification, datasets, judges, metrics, CLI, API, result persistence, and evidence publication.
|
||||
|
||||
### [SPEC-007 — Observability](specs/SPEC-007-Observability.md)
|
||||
### [SPEC-007 — Observability](specs/en/SPEC-007-Observability.md)
|
||||
|
||||
Specifies the observability model, including logs, traces, metrics, Langfuse, OpenTelemetry, IC/NOC/GRL events, dashboards, alerts, data masking, and operational evidence generation.
|
||||
|
||||
### [SPEC-008 — Deployment](specs/SPEC-008-Deployment.md)
|
||||
### [SPEC-008 — Deployment](specs/en/SPEC-008-Deployment.md)
|
||||
|
||||
Describes the platform packaging and deployment process, including deployable components, CI/CD pipelines, Kubernetes/OKE, Docker, secrets, OCI authentication, health checks, rollback, smoke tests, and certification stages.
|
||||
|
||||
### [SPEC-009 — Channel Gateway](specs/SPEC-009-Channel-Gateway.md)
|
||||
### [SPEC-009 — Channel Gateway](specs/en/SPEC-009-Channel-Gateway.md)
|
||||
|
||||
Defines the channel gateway responsible for normalizing external payloads into the platform's canonical contract and translating responses for each channel. Covers operating modes, idempotency, versioning, security, errors, and anti-patterns.
|
||||
|
||||
### [SPEC-010 — Agent Development](specs/SPEC-010-Agent-Development.md)
|
||||
### [SPEC-010 — Agent Development](specs/en/SPEC-010-Agent-Development.md)
|
||||
|
||||
Describes the standard for agent development using templates, YAML configuration, BusinessContext, MCP, guardrails, judges, RAG, memory, observability, and evaluations. It also differentiates framework and agent responsibilities.
|
||||
|
||||
### [SPEC-011 — Governance Model](specs/SPEC-011-Governance-Model.md)
|
||||
### [SPEC-011 — Governance Model](specs/en/SPEC-011-Governance-Model.md)
|
||||
|
||||
Defines the platform governance model, including ownership, roles and responsibilities, RACI, agent governance, prompts, guardrails, judges, models, MCP, datasets, approval processes, and mandatory evidence.
|
||||
|
||||
### [SPEC-012 — Canonical Contracts](specs/SPEC-012-Canonical-Contracts.md)
|
||||
### [SPEC-012 — Canonical Contracts](specs/en/SPEC-012-Canonical-Contracts.md)
|
||||
|
||||
Documents the platform's canonical contracts, including GatewayRequest, ChannelResponse, BusinessContext, AgentState, ToolInvocation, ToolResult, LLMRequest, LLMResponse, EvaluationRun, and EventEnvelope. It also defines contract evolution rules.
|
||||
|
||||
### [SPEC-013 — Versioning and Compatibility Model](specs/SPEC-013-Versioning-and-Compatibility-Model.md)
|
||||
### [SPEC-013 — Versioning and Compatibility Model](specs/en/SPEC-013-Versioning-and-Compatibility-Model.md)
|
||||
|
||||
Defines the platform versioning and compatibility model, including Semantic Versioning, versioned artifacts, contract versioning, compatibility matrices, deprecation policies, migration, and rollback.
|
||||
|
||||
### [SPEC-014 — Templates and Agent Creation Model](specs/SPEC-014-Templates-and-Agent-Creation-Model.md)
|
||||
### [SPEC-014 — Templates and Agent Creation Model](specs/en/SPEC-014-Templates-and-Agent-Creation-Model.md)
|
||||
|
||||
Describes the official templates and the agent creation model from scratch. Explains what belongs to the framework, what belongs to the agent, the standard structure, and the step-by-step process for copying templates, defining scope, registering agents, configuring routes, tools, BusinessContext, prompts, datasets, and tests.
|
||||
|
||||
### [SPEC-015 — Adoption and Eligibility Criteria](specs/SPEC-015-Adoption-and-Eligibility-Criteria.md)
|
||||
### [SPEC-015 — Adoption and Eligibility Criteria](specs/en/SPEC-015-Adoption-and-Eligibility-Criteria.md)
|
||||
|
||||
Defines clear platform adoption criteria, including recommended and non-recommended use cases, business entry criteria, architecture, security, quality, operations, exception processes, and adoption checklists.
|
||||
|
||||
### [SPEC-016 — Agent Development Lifecycle](specs/SPEC-016-Agent-Development-Lifecycle.md)
|
||||
### [SPEC-016 — Agent Development Lifecycle](specs/en/SPEC-016-Agent-Development-Lifecycle.md)
|
||||
|
||||
Describes the complete agent development lifecycle, from discovery and scope definition through design, prompting, MCP, RAG, implementation, testing, evaluation, certification, validation, and production.
|
||||
|
||||
### [SPEC-017 — Release Management and CI/CD](specs/SPEC-017-Release-Management-and-CICD.md)
|
||||
### [SPEC-017 — Release Management and CI/CD](specs/en/SPEC-017-Release-Management-and-CICD.md)
|
||||
|
||||
Defines the release and CI/CD model, including standard pipelines, stages, release artifacts, quality gates, rollback strategies, common errors, and acceptance criteria.
|
||||
|
||||
### [SPEC-018 — Security and Identity Model](specs/SPEC-018-Security-and-Identity-Model.md)
|
||||
### [SPEC-018 — Security and Identity Model](specs/en/SPEC-018-Security-and-Identity-Model.md)
|
||||
|
||||
Specifies the platform security and identity model, covering authentication, Workload Identity, authorization, secrets, data protection, MCP security, channel security, auditing, and acceptance criteria.
|
||||
|
||||
### [SPEC-019 — Evaluation and Certification Framework](specs/SPEC-019-Evaluation-and-Certification-Framework.md)
|
||||
### [SPEC-019 — Evaluation and Certification Framework](specs/en/SPEC-019-Evaluation-and-Certification-Framework.md)
|
||||
|
||||
Details the evaluation and certification framework, including evaluation architecture, metrics, datasets, EvaluationRun, CLI, certification processes, mandatory evidence, and acceptance criteria.
|
||||
|
||||
### [SPEC-020 — Operational Readiness and SRE Model](specs/SPEC-020-Operational-Readiness-and-SRE-Model.md)
|
||||
### [SPEC-020 — Operational Readiness and SRE Model](specs/en/SPEC-020-Operational-Readiness-and-SRE-Model.md)
|
||||
|
||||
Defines the platform operational readiness and SRE model, including managed components, health checks, readiness, SLOs, metrics, dashboards, alerts, runbooks, incident management, capacity planning, and production checklists.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user