Welcome to MCP Governance Documentation
This site provides comprehensive documentation for the @ithena-one/mcp-governance
SDK, a framework for adding robust governance controls (identity, RBAC, auditing, logging, etc.) to servers built with the @modelcontextprotocol/sdk
.
Explore the guides and API references to learn how to integrate and utilize MCP Governance in your Model Context Protocol (MCP) projects.
Key Features
- Identity Resolution: Plug in your authentication system to identify callers.
- Role-Based Access Control (RBAC): Define roles and permissions to control access to MCP methods (tools, resources).
- Auditing: Log detailed records of requests, responses, and governance decisions.
- Structured Logging: Consistent logging throughout the request lifecycle.
- Credential Management: Securely resolve and inject credentials needed by your handlers.
- Extensible Pipeline: Customize the governance flow with hooks.
Getting Started
Jump right in by following the Getting Started Guide. This guide walks you through:
- Wrapping a base MCP
Server
with theGovernedServer
. - Configuring essential governance components (using simple in-memory examples initially).
- Registering your MCP request handlers with the
GovernedServer
. - Understanding how identity and RBAC flow through the system.
Core Concepts
To effectively use the SDK, understand these fundamental concepts explained in the Core Concepts section:
GovernedServer
: The main entry point that orchestrates the governance process around a base MCPServer
.- Governance Pipeline: The sequence of steps (Identity, RBAC, Credentials, Auditing, etc.) applied to each request.
OperationContext
: An object carrying contextual information through the pipeline.- Lifecycle Management: How the SDK manages the initialization and shutdown of governance components.
Explore the Documentation
Use the navigation menu to browse through different sections:
- About: Learn more about the MCP Governance project goals.
- SDKs: Dive into the TypeScript SDK documentation, covering configuration, interfaces, security, and more.
- [Other Sections as needed]
We hope you find this documentation helpful!
Last updated on