Package Exports
- @fractary/codex-mcp
Readme
@fractary/codex-mcp
MCP (Model Context Protocol) server for Fractary Codex knowledge management.
Overview
Standalone MCP server that exposes Fractary Codex functionality as tools for AI agents. Supports stdio (default) and HTTP/SSE transports.
Installation
# Direct usage (recommended)
npx @fractary/codex-mcp
# Global install
npm install -g @fractary/codex-mcpQuick Start
Claude Code / MCP Client Integration
Add to .mcp.json in your project root:
{
"mcpServers": {
"fractary-codex": {
"command": "npx",
"args": ["-y", "@fractary/codex-mcp", "--config", ".fractary/config.yaml"]
}
}
}Stdio Mode (default)
fractary-codex-mcp --config .fractary/config.yamlHTTP Mode
fractary-codex-mcp --port 3000 --host localhostAvailable Tools
| Tool | Description |
|---|---|
codex_document_fetch |
Fetch a document by codex:// URI |
codex_cache_list |
List cached documents |
codex_cache_clear |
Clear cache entries by pattern |
codex_cache_stats |
Get cache statistics |
codex_cache_health |
Run health diagnostics |
codex_file_sources_list |
List file plugin sources |
codex_document_fetch
Fetch a document by its codex:// URI with automatic caching.
Parameters:
uri(string, required) - Codex URI (e.g.,codex://org/project/docs/file.md)noCache(boolean, optional) - Bypass cache and fetch fresh contentbranch(string, optional) - Git branch to fetch from (default:main)
codex_cache_list
List documents currently in the cache.
Parameters:
org(string, optional) - Filter by organizationproject(string, optional) - Filter by projectincludeExpired(boolean, optional) - Include expired cache entries
codex_cache_clear
Clear cache entries matching a pattern.
Parameters:
pattern(string, required) - URI pattern to invalidate (supports regex)
codex_cache_stats
Get cache statistics (entry count, total size, hit rates).
Parameters:
json(boolean, optional) - Return raw JSON stats object
codex_cache_health
Run diagnostics on the codex setup.
Parameters:
json(boolean, optional) - Return raw JSON health check results
codex_file_sources_list
List file plugin sources configured in .fractary/config.yaml. No parameters.
Configuration
Uses .fractary/config.yaml:
codex:
schema_version: "2.0"
organization: myorg
project: myproject
codex_repo: codex.myorg.com
remotes:
myorg/codex.myorg.com:
token: ${GITHUB_TOKEN}See the Configuration Guide for the full reference.
Environment Variables
| Variable | Description |
|---|---|
GITHUB_TOKEN |
GitHub API token for private repository access |
Development
npm run build
npm run dev # watch mode
npm test
npm run typecheckLicense
MIT