From 8d49418b8322c8270b25e43ef7897fc3b5a4bda6 Mon Sep 17 00:00:00 2001 From: Tetsuji Kato <6571039+iwizsophy@users.noreply.github.com> Date: Sat, 4 Apr 2026 23:30:38 +0900 Subject: [PATCH 1/2] Run CI on all branches --- .github/workflows/ci.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ef0db23..dd193bb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -2,9 +2,6 @@ name: CI on: push: - branches: - - main - - develop tags-ignore: - "v*" pull_request: From bf05407a710b2638214e096f63258b7e028523a7 Mon Sep 17 00:00:00 2001 From: Tetsuji Kato <6571039+iwizsophy@users.noreply.github.com> Date: Sun, 5 Apr 2026 16:35:15 +0900 Subject: [PATCH 2/2] Add background section to READMEs --- README.ja.md | 18 ++++++++++++++++++ README.md | 18 ++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/README.ja.md b/README.ja.md index 41fb195..1339b8c 100644 --- a/README.ja.md +++ b/README.ja.md @@ -8,6 +8,24 @@ `scriptorium` は、Markdown とコードを根拠付きで検索・参照するための MCP ランタイムです。このリポジトリには、Go 実装、リリース用パッケージ、各種アーティファクトビルダーが含まれます。 +## 背景 + +ライブラリのドキュメントやサンプルコードは整備されているにもかかわらず、AI による活用は十分に機能していませんでした。 + +AI はドキュメント全体を都度広く参照する傾向があり、必要な情報だけを効率的に取得することが難しく、また参照元の一貫性や再現性にも課題がありました。 + +さらに、サンプルコードやドキュメントなどの情報を提供していても、人間にとっては理解可能であっても、AI にとっては構造的に扱いづらい場合があります。 + +その結果、「情報は存在するが、活用できない」という状態が生じていました。 + +この課題を解決するために、ドキュメント・サンプルコード・実装知識を一体として扱い、AI が自然に参照できる形で提供する仕組みとして `scriptorium` を開発しました。 + +`scriptorium` は、Markdown とコードを統合的に解析し、検索・参照・実装ガイド生成の各結果に対して根拠となる参照元を付与する MCP ランタイムです。 + +これにより、取得した情報の出所を追跡可能にし、AI 支援を含む開発プロセスにおいて再現性と検証可能性を確保します。 + +また、利用者は情報の所在や参照方法を意識することなく、必要な知識に一貫した形でアクセスできるようになります。 + ## ランタイム文書 現在のランタイム仕様とアーティファクトの挙動は、次の文書を参照してください。 diff --git a/README.md b/README.md index 9baebc8..8dee57b 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,24 @@ English | [日本語](./README.ja.md) `scriptorium` is an MCP runtime for grounded Markdown and code retrieval. This repository contains the Go implementation, release packaging, and artifact builders for the runtime. +## Background + +Even when library documentation and sample code are well maintained, AI-driven usage has often not worked well enough in practice. + +AI tends to scan broad portions of the documentation on each request, making it difficult to retrieve only the necessary information efficiently. This also creates problems for consistency and reproducibility in the referenced sources. + +In addition, even when documentation, sample code, and related materials are available, information that is understandable for humans is not always structured in a way that AI can handle effectively. + +As a result, teams can end up in a state where "the information exists, but it cannot be used well." + +`scriptorium` was developed to address this problem by treating documentation, sample code, and implementation knowledge as a single connected source of truth that AI can reference naturally. + +`scriptorium` is an MCP runtime that analyzes Markdown and code together and attaches grounded references to the sources behind search, retrieval, and implementation-guide generation results. + +This makes the origin of retrieved information traceable and helps preserve reproducibility and verifiability in development workflows, including AI-assisted ones. + +It also allows users to access the knowledge they need in a consistent way without having to think explicitly about where the information lives or how it should be referenced. + ## Runtime Docs Current runtime and artifact behavior is documented in: