Skip to main content
Glama

okfshare CLI and MCP server

npm: okfshare npm: @okfshare/mcp npm: @okfshare/agent-installer Site

Client-side, open-source half of okfshare: shared, versioned knowledge for AI coding agents.

Publish a validated bundle of Markdown once. Every authorized agent works from the same immutable revision, with line-level citations you can audit. The hosted service keeps revisions, citations, and workspace auth; this repo holds the tools your agents actually run.

Packages

Package

Command

Purpose

okfshare

npx okfshare@latest

CLI: setup, publish, search, context, diff, rollback

@okfshare/mcp

npx @okfshare/mcp@latest

MCP server for Claude Code, Cursor, opencode, Codex

@okfshare/agent-installer

okfshare-agent

Installs okfshare skills into agent tooling

Related MCP server: Trove

Quick start

# 1. One-time onboarding (device pairing in your browser)
npx okfshare@latest setup

# 2. Validate and publish a folder of Markdown
npx okfshare@latest validate ./knowledge
npx okfshare@latest publish ./knowledge --visibility public --yes

# 3. Any teammate's agent retrieves cited context
npx okfshare@latest context SHARE_ID "how do we handle db migrations"

Headless/CI environments: supply a pre-provisioned credential via the OKFSHARE_TOKEN environment variable (check existence only; never log it), then verify with whoami and doctor.

MCP setup

claude mcp add okfshare -- npx @okfshare/mcp@latest

Or any MCP client:

{
  "mcpServers": {
    "okfshare": {
      "command": "npx",
      "args": ["@okfshare/mcp@latest"]
    }
  }
}

Tools: whoami, doctor, list_shares, search_share, search_workspace, get_context, pull_bundle, publish_bundle. Registry manifest: server.json.

Why citations matter

Retrieval returns the file, the exact lines, and the immutable revision they came from. When an agent claims "our convention says X", you can audit the claim in seconds - and a citation means the same thing tomorrow, because revision content never changes in place.

The Open Knowledge Format

Bundles are Markdown with structured frontmatter: a type, title, description, tags, sources, and verification events. The format is deliberately small and stays readable in any editor. Worst case, you are left with plain files - no lock-in.

Development

pnpm install
pnpm check   # typecheck + test + build across all packages
  • Node 20+ and pnpm 10.

  • The packages talk to the hosted API at https://okfshare.app; no local server is required to develop them.

  • See CONTRIBUTING.md for the acceptance flow and SECURITY.md for reporting vulnerabilities.

License

Apache-2.0. See NOTICE - the code license does not grant rights to the okfshare name or branding.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      C
      maintenance
      Enables humans and AI coding agents such as Claude Code, Codex, Cursor, and Gemini CLI to pass in-progress work between each other through shared, versioned, authenticated context that preserves decisions, artifacts, evidence, review history, and authorship. It exposes identity, search, retrieval, review, continuation, publishing, and portability tools over a Streamable HTTP endpoint.
      4
      MIT
    • A
      license
      Not graded
      quality
      B
      maintenance
      Enables AI coding tools to query a local index of documents, code, and crawled web pages using hybrid keyword and semantic search with re-ranking, plus knowledge graph, memory, and agent workflow tools. It also lets clients trigger source syncing and ingestion so context stays current.
      Business Source 1.1
    • A
      license
      Not graded
      quality
      B
      maintenance
      Enables AI agents to search, read, create, patch, lint, and synchronize a shared Markdown+git knowledge base across multiple machines and sessions, with confidence metadata and protocol resources.
      1
      MIT
    • A
      license
      Not graded
      quality
      C
      maintenance
      Enables AI agents and their human owners to browse, search (keyword, semantic, and hybrid), create, and revise a versioned personal knowledge base of Markdown documents, checkpoint summaries, and structured tasks. Access is OAuth-protected with separately grantable read and write scopes, and edits are history-tracked with conflict protection so concurrent clients don't overwrite each other.
      3
      MIT