Skip to main content
Glama

huiwen-mcp

Model Context Protocol (MCP) сервер для системы управления библиотекой Huiwen (Libsys / OPAC) — только для чтения шлюз данных библиотеки для ИИ: позволяет AI-клиентам (Claude / Cherry Studio / DeepSeek и др.) безопасно и с аудитом получать данные о фондах, наличии экземпляров, статистике выдачи и объединённом каталоге.

Официальный адаптационный слой, разработанный библиотекой университета, соблюдающий базовые принципы безопасности: только чтение, минимальные привилегии, полный аудит всей цепочки.

  • Протокол: Model Context Protocol (открытый стандарт Anthropic, та же технологическая линия, что и подключение каталога Yale Library)

  • Среда выполнения: Python ≥ 3.10 · FastMCP 3.x

  • Источники данных: demo (нулевая зависимость, демонстрация) / opac (открытый веб-протокол Huiwen OPAC) / oracle (прямое подключение только для чтения к базе данных Huiwen Libsys)

  • Лицензия: Apache-2.0 (рекомендуемый вариант, см. Лицензия и соответствие)


Содержание

  1. Функциональные возможности

  2. Концепция проектирования системы

  3. Техническая реализация

  4. Быстрый старт

  5. Конфигурация (переменные окружения / .env)

  6. Список инструментов

  7. Примеры подключения клиентов

  8. Сценарии использования

  9. Безопасность и соответствие требованиям

  10. Тестирование

  11. Структура проекта

  12. План развития

  13. Лицензия и соответствие

  14. Устранение неполадок


Related MCP server: dms-mcp-server

Функциональные возможности

Возможность

Описание

🔍 Поиск по фондам

Много полей / по классификации Китайской библиотечной классификации / по месту хранения / фильтр наличия / сортировка / постраничный вывод

📚 Детальная информация о книге

Полная библиографическая запись, статус всех экземпляров и статистика выдачи

✅ Наличие экземпляров

Быстрая проверка доступности по ISBN / штрихкоду / названию

🔥 Популярные и новые книги

Рейтинг популярных книг, уведомления о новых поступлениях за последние N дней

🧭 Просмотр по категориям

Количество совпадений по категориям/префиксам Китайской библиотечной классификации в реальном времени

📊 Статистика

Общее количество фондов / по месту хранения / по категориям

🤝 Объединённый каталог консорциума

PROCAT межбиблиотечный поиск (опционально, по умолчанию выключен, аутентификация JWT)

👤 Данные читателя (admin)

Текущие выдачи / история выдачи / задолженности (PII по умолчанию обезличиваются)

🛡️ Безопасность

Аутентификация → ограничение запросов → шлюз PII/читателя → аудит JSONL; только чтение по умолчанию

🔌 Транспорт

stdio (внутри процесса) / Streamable HTTP (сервис)

🐳 Развёртывание

Docker-образ (не root, воспроизводимая сборка); решения для производственного/шлюзового уровня аутентификации см. в docs/руководство-по-развертыванию.md

🧩 Подключаемые источники данных

demo / opac / oracle — переключение одним кликом, одинаковые сигнатуры инструментов

Компромиссы в проектировании: операции записи (продление, бронирование, межбиблиотечный заказ) намеренно не реализованы — этот проект предназначен только для “безопасного и аудируемого чтения”, пути записи оставлены исходным бизнес-системам и ручным процессам.


Концепция проектирования системы

Позиционирование: шлюз данных / уровень навыков, а не прокси базы данных

AI-клиенты (большие языковые модели) никогда не подключаются напрямую к базе данных Huiwen. Все запросы инкапсулируются через контролируемый слой инструментов:

┌─────────────── AI 客户端(Claude / Cherry Studio / 自研 Agent / 本地 LLM) ───────────────┐
│                                      │                                                    │
│             stdio(子进程协议)        │        Streamable HTTP(服务化 / 网关 / SSO)        │
└──────────────────────────────────────┼────────────────────────────────────────────────────┘
                                       ▼
┌───────────────────────────────────────────────────────────────────────────────────────┐
│   huiwen-mcp(FastMCP 3.x)                                                            │
│   ┌─────────────── 安全链 _guard ───────────────┐                                        │
│   │ 认证(Auth) → 限流(TokenBucket) → 门控(PII/读者) │   ← 每个工具必经                     │
│   └──────────────────────────────────────────────┘                                        │
│   │ 工具层:search_books / get_book_detail / union_search / get_reader_* / … (12 个)     │
│   └──────────────────────────────────┬───────────────────────────────────────────────────┘
                                       ▼
┌───────────────────────────────────────────────────────────────────────────────────────┐
│   适配器(可插拔数据源,统一 CatalogBackend 接口)                                       │
│   ├─ OracleBackend:白名单参数化 SQL(db/queries.py 封闭集)   → 汇文 Libsys 只读账号    │
│   ├─ OpacBackend:白名单参数调汇文 OPAC 公开网页协议           → opac 站点                │
│   └─ DemoBackend:内置样例数据                                 → 离线演示/测试            │
└───────────────────────────────────────────────────────────────────────────────────────┘
  • Каждый уровень имеет единственную ответственность: адаптер отвечает только за получение данных; _guard отвечает только за безопасность; аудит независимо записывает JSONL; верхний уровень AI взаимодействует только с сигнатурами инструментов, не чувствуя различий в бэкендах (три бэкенда с одинаковыми сигнатурами).

  • Безопасность по умолчанию: data_source=demo не требует зависимостей для запуска; opac/oracle требуют явной настройки; инструменты для чувствительных данных читателя требуют admin-токена; операции записи отключены по умолчанию; внешние сервисы консорциума отключены по умолчанию.

Почему выбран MCP

  • MCP — открытый стандарт для подключения AI к "базам данных/бизнес-системам" (выпущен Anthropic в ноябре 2024, экосистема включает GitHub/облачные провайдеры/поставщиков баз данных). Выбор открытого стандарта, а не частного API, гарантирует: взаимозаменяемость клиентов (Claude/Cherry Studio/DeepSeek/собственные агенты), возможность повторного использования сервиса несколькими системами, отсутствие привязки к поставщику в долгосрочной перспективе — это тот же путь, который Yale Library использует для подключения каталога через MCP.

  • FastMCP предоставляет двойной транспорт stdio/HTTP для реализации сервера, один код поддерживает как внутрипроцессное, так и сервисное развёртывание.

Выбор режима транспорта: stdio vs HTTP

  • stdio: внутри процесса, запускается вместе с клиентом, нулевое администрирование, минимальная задержка, подходит для персонального/одномашинного подключения к AI-клиентам на рабочем столе.

  • HTTP (Streamable HTTP): независимый сервис, подходит для многопользовательского/централизованного развёртывания; можно разместить перед ним обратный прокси с OAuth2/JWT и единой аутентификацией кампуса для централизованного аудита.


Техническая реализация

Аспект

Решение

MCP сервер

fastmcp>=2,<4; регистрация через add_tool; двойной run() для stdio/http

Строгие ограничения сигнатур инструментов

FastMCP 3.x отклоняет функции инструментов с *args/**kwargs → инструменты всегда имеют явно типизированные параметры; _guard оборачивает с помощью functools.wraps и передаёт kwargs (явная модель токена, избегает **kwargs, чтобы не вызвать отклонение фреймворком)

Цепочка аутентификации

AuthConfig (Bearer) + RateLimit (ведро токенов) + шлюз читателя/PII (admin-токен) + AuditLogger (JSONL)

Бэкенд Oracle

python-oracledb; 11g → толстый режим (Instant Client), 12c+ → тонкий; SQL полностью закрыт в db/queries.py (параметризованные, белый список, учётная запись только для чтения)

Бэкенд OPAC

Параметры из белого списка конструируют открытый веб-протокол Huiwen (openlink.php поиск / item.php детали / top_lend.php популярное), парсинг открытых HTML-шаблонов (селекторы сверены с шаблонами вендора поэлементно)

Объединённый каталог консорциума

POST {base}/api/search/listByQuery + {current,pageSize,items:[{field,value,logic,type}]} + ?tenantCode&tk=<JWT> (контракт проверен на реальном стенде); по умолчанию выключен

Конфигурация

Переменные окружения HUIWEN_ (автозагрузка .env) + config.local.json (чувствительные значения, в git-ignored, автоматическое объединение)

Модели

pydantic явные модели результатов, типобезопасность, стабильная сериализация

Ключевые контракты (все проверены на реальном стенде)

  • OPAC: результаты поиска <ol id="search_book_list"> → <li class="book_list_info">, название/шифр/количество экземпляров/доступных экземпляров/количество совпадений; таблица копий на странице деталей; список популярных.

  • Консорциум PROCAT: POST (GET→405); аутентификация через параметр запроса tk= (JWT выдается сессией читателя OPAC через getReaderJwt); items[].logic="1"(AND)/"2"(OR); сопоставление полей any/title/author/subject/isbn/clcNumber/publisher/series. Подробнее см. docs/поиск-по-объединенному-каталогу-консорциума.md.

⚠️ OPAC и консорциум являются закрытыми системами вендора или сторонними системами, контракты могут меняться в зависимости от версии развёртывания. Вся документация по интеграции основана на "проверке на реальном стенде" и записана в tests/test_*_live.py.


Быстрый старт

1) Установка

git clone <your-repo-url> && cd huiwen-mcp
# 方式 A:uv(推荐)
uv sync
# 方式 B:pip
python -m venv .venv
. .venv/bin/activate
pip install -e .

2) Быстрый запуск без конфигурации (источник данных demo, офлайн)

HUIWEN_DATA_SOURCE=demo uv run huiwen-mcp        # stdio 模式
HUIWEN_DATA_SOURCE=demo HUIWEN_TRANSPORT=http uv run huiwen-mcp   # HTTP 模式

В demo встроены примеры библиографических записей/данных читателя, можно использовать для smoke-тестирования, тестирования и обучения подключению.

2b) Развёртывание в один клик через Docker

docker build -t huiwen-mcp:latest .
docker run --rm -it -e HUIWEN_DATA_SOURCE=demo huiwen-mcp:latest   # stdio,离线可跑

# 服务化(HTTP + 认证 + 审计)
docker run -d --name huiwen -p 8765:8765 \
  -e HUIWEN_TRANSPORT=http -e HUIWEN_DATA_SOURCE=opac \
  -e HUIWEN_OPAC_BASE_URL=https://opac.example.edu.cn \
  -e HUIWEN_AUTH_ENABLED=true -e HUIWEN_AUTH_BEARER_TOKEN=<强随机> \
  -v huiwen-audit:/var/log/huiwen huiwen-mcp:latest

Больше (Oracle 11g толстый режим / compose / аутентификация на уровне обратного прокси для интеграции с кампусным CAS) см. в docs/руководство-по-развертыванию.md.

3) Подключение к реальному источнику данных (opac / oracle)

Скопируйте .env.example в .env и заполните (.env уже в git-ignore):

cp .env.example .env
# 编辑 .env:设置 HUIWEN_DATA_SOURCE 与对应凭据
HUIWEN_DATA_SOURCE=opac
HUIWEN_OPAC_BASE_URL=https://opac.example.edu.cn      # 你们学校 OPAC 地址

Или используйте config.local.json (чувствительная конфигурация загружается автоматически, не попадает в репозиторий).


Конфигурация (переменные окружения / .env)

Все конфигурации могут быть переданы через переменные окружения (префикс HUIWEN_), также поддерживается файл .env (автозагрузка). Приоритет: переменные окружения > явный config.json / CONFIG_PATH > автоматическое объединение config.local.json > встроенные значения по умолчанию.

Общие

Переменная

Описание

По умолчанию

HUIWEN_DATA_SOURCE

demo / opac / oracle

demo

HUIWEN_TRANSPORT

stdio / http

stdio

HUIWEN_HOST / HUIWEN_PORT

HTTP прослушивание

127.0.0.1 / 8765

HUIWEN_INCLUDE_PII

Выводить ли чувствительные поля читателя (требуется admin)

false

HUIWEN_AUDIT_LOG

Путь к JSONL-логу аудита (оставить пустым для отключения)

пусто

HUIWEN_CONFIG_LOCAL_PATH

Имя файла локальной чувствительной конфигурации

config.local.json

OPAC

Переменная

Описание

HUIWEN_OPAC_BASE_URL

Корневой адрес Huiwen OPAC

HUIWEN_OPAC_TIMEOUT

Таймаут поиска (корзина 15-40s медленно, дайте достаточно)

25s

HUIWEN_OPAC_ALLOW_READER_SESSION

Разрешить ли персональные данные после входа читателя (по умолчанию выкл)

HUIWEN_OPAC_UNION_ENABLED

Включить объединённый каталог консорциума (по умолчанию выкл)

HUIWEN_OPAC_UNION_BASE_URL

Адрес сервиса консорциума

HUIWEN_OPAC_UNION_TENANT

Код арендатора

HUIWEN_OPAC_UNION_TOKEN

JWT сессии читателя (целая строка getReaderJwt)

Oracle

Переменная

Описание

HUIWEN_ORACLE_DSN

host:port/service или Easy Connect

HUIWEN_ORACLE_USER / _PASSWORD

Учётная запись только для чтения (настоятельно рекомендуется)

HUIWEN_ORACLE_MODE

thin (12c+) / thick (11g/10g требуется Instant Client)

HUIWEN_ORACLE_CLIENT_LIB_DIR

Каталог Instant Client для толстого режима

HUIWEN_ORACLE_READ_ONLY

Семантическое ограничение только для чтения (по умолчанию true)

HUIWEN_ORACLE_POOL_MIN/MAX

Размер пула соединений

Безопасность

Переменная

Описание

HUIWEN_AUTH_ENABLED

Включить ли аутентификацию Bearer (обязательно для продакшена)

HUIWEN_AUTH_BEARER_TOKEN

Статический Bearer Token

HUIWEN_AUTH_ADMIN_TOKENS

Admin-токены, разделённые запятыми (для инструментов читателя/экспорта)

HUIWEN_RATE_LIMIT_ENABLED / _RPS / _BURST

Ограничение запросов ведром токенов


Список инструментов

Инструмент

Описание

Требуется токен

search_books

Поиск по фондам (поля/классификация/место хранения/фильтр наличия/сортировка/страницы)

—

get_book_detail

Полная информация о книге (все копии и статистика выдачи)

—

get_availability

Проверка доступности копий по ISBN/штрихкоду/названию

—

get_hot_books

Рейтинг популярных книг (можно фильтровать по категории Китайской библиотечной классификации)

—

get_new_arrivals

Уведомления о новых поступлениях за последние N дней

—

browse_classification

Просмотр по категориям Китайской библиотечной классификации / количество совпадений по префиксу в реальном времени

—

union_search

Поиск только для чтения по объединённому каталогу консорциума (по умолчанию выключен)

Конфигурация

get_statistics

Статистика фондов (общее/по месту хранения/по категориям)

—

get_reader_borrowing

Текущие выдачи читателя

admin

get_reader_history

История выдачи читателя

admin

get_reader_fines

Задолженности читателя

admin

get_system_status

Статус источника данных и сервиса

—

Описание функций и оценка интеграции сервисных интерфейсов Huiwen ACS / SIP2 см. в docs/описание-и-оценка-интерфейсов-Huiwen-ACS-SIP2.md (авторитетное сопоставление полей, кандидаты для подмножества только для чтения, явно запрещённые элементы).

Инструменты для читателя по умолчанию обезличивают данные (include_pii=false не возвращает номер документа/контактные данные; для true требуется admin).


Примеры подключения клиентов

Claude Desktop / настольные клиенты, поддерживающие MCP

{
  "mcpServers": {
    "huiwen": {
      "command": "/path/to/uv",
      "args": ["--directory", "/path/to/huiwen-mcp", "run", "huiwen-mcp"],
      "env": { "HUIWEN_DATA_SOURCE": "demo" }
    }
  }
}

Удалённый HTTP (требуется самостоятельная аутентификация на шлюзе)

HUIWEN_TRANSPORT=http HUIWEN_HOST=0.0.0.0 HUIWEN_PORT=8765 uv run huiwen-mcp

Клиент подключается к http://<host>:8765/mcp/ (Streamable HTTP) с использованием ${MCP_SERVER_URL}. При включении HUIWEN_AUTH_ENABLED=true токен передаётся как параметр инструмента token вместе с вызовом; заголовок HTTP Authorization не потребляется сервером (см. руководство по развёртыванию §3.2).


Сценарии использования

Объект

Сценарий

Читатель

"Есть ли «Три тела», на каком этаже, сколько экземпляров доступно, что популярно рядом" — поиск книг/подготовка к экзаменам/исследования одним махом

Библиотекарь справочной службы

Автоматический поиск по фондам/копиям → генерация черновика ответа → ручная проверка (режим Copilot)

Библиотекарь-предметник

Тематические библиографии, статистика информационной поддержки, отчёты о рекомендациях по закупке факультетов

Комплектование/каталогизация

Проверка дубликатов по ISBN, анализ отсутствующих фондов, уведомления о новых поступлениях, проверка метаданных

Руководство библиотеки

Диаграммы статистики фондов/выдачи, еженедельные отчёты по данным

Портал библиотеки с ИИ

Внутренний уровень данных для интеллектуальных вопросов-ответов/рекомендаций книг

Совместное строительство консорциума

Межбиблиотечный поиск (отсутствующие фонды → поиск книг в консорциуме → официальный межбиблиотечный обмен)

Полные рекомендации (включая локально развёрнутую LLM + RAG с многоуровневой схемой и сравнением с аналогами внутри страны и за рубежом) см. в docs/рекомендации-по-сервису-и-применению.md.


Безопасность и соответствие требованиям

  1. Только чтение по умолчанию: все инструменты только для чтения; операции записи (продление/бронирование/межбиблиотечный заказ) намеренно не реализованы.

  2. Белый список SQL: бэкенд Oracle выполняет только параметризованные SQL-запросы из закрытого набора db/queries.py, свободный SQL отсутствует.

  3. Шлюзы по всей цепочке: аутентификация → ограничение запросов → шлюз читателя/PII → аудит (JSONL). Персональные данные читателя требуют admin-токена и по умолчанию обезличиваются.

  4. Контракт аутентификации (проверено на реальном стенде): токен передаётся через параметр инструмента token (каждый инструмент имеет опциональный параметр, _guard извлекает его из параметров и сравнивает с HUIWEN_AUTH_BEARER_TOKEN), передача через HTTP-заголовок Authorization не реализована — транспортный уровень TLS/единая аутентификация обеспечивается обратным прокси-шлюзом, аутентификация самого huiwen-mcp является второй линией защиты за шлюзом. Токен не записывается в журнал аудита (_guard сначала извлекает его, затем записывает).

  5. Ключи не попадают в репозиторий: DSN/пароли/JWT/адреса сайтов передаются только через переменные окружения или config.local.json (в git-ignored). Репозиторий не содержит никаких реальных данных развёртывания (см. NOTICE).

  6. Внешние сервисы с осторожностью: консорциум PROCAT — сторонняя мультиарендная система, по умолчанию выключена; перед включением получите разрешение от консорциума/провайдера сервиса. OPAC является закрытым, исторически имел открытые уязвимости, адаптер использует только параметры из белого списка.

  7. Сообщение и обработка уязвимостей см. в SECURITY.md.


Тестирование

Файл

Содержание

Запуск

tests/smoke_demo.py

Smoke-тест бэкенда demo (офлайн)

uv run python tests/smoke_demo.py

tests/test_stdio.py

Интеграционное/регрессионное тестирование stdio (demo)

uv run python tests/test_stdio.py

tests/test_oracle_live.py

Интеграция с реальной БД (по умолчанию выключено)

HUIWEN_LIVE_ORACLE=1 ...

tests/test_union_live.py

Реальный стенд консорциума PROCAT (по умолчанию выключено)

HUIWEN_LIVE_UNION=1 ...

Тесты на реальной БД/реальном стенде по умолчанию выключены (требуется явная локальная установка HUIWEN_LIVE_* для выполнения), чтобы не затрагивать никакие реальные системы. Docker-образ по умолчанию не собирается/не публикуется (стратегия публикации: "публикуются только исходный код и документация"): если нужен образ, соберите локально docker build (для толстого режима Oracle добавьте --build-arg WITH_INSTANT_CLIENT=true).


Структура проекта

huiwen-mcp/
├── src/huiwen_mcp/
│   ├── server.py            # FastMCP 装配、stdio/http 启动、main()
│   ├── config.py            # 配置:env/.env/config.local.json 分层合并
│   ├── audit.py             # JSONL 审计
│   ├── adapters/
│   │   ├── base.py          # CatalogBackend 抽象
│   │   ├── demo.py          # 内置演示数据
│   │   ├── opac.py          # 汇文 OPAC 网页协议(含 union_search)
│   │   └── oracle.py        # Libsys 数据库只读(thin/thick)
│   ├── db/queries.py        # 白名单参数化 SQL(Oracle 后端唯一 SQL 来源)
│   ├── models/schemas.py    # pydantic 结果模型
│   └── tools/catalog.py     # 12 个 MCP 工具 + _guard 安全链
├── docs/                    # 表结构 / 联盟契约 / 服务与应用建议 / 部署指南 / SIP2 评估
├── tests/                   # demo/stdio/oracle-live/union-live
├── Dockerfile / compose.yaml / .dockerignore
├── .env.example / config.example.json / config.local.json(忽略)
├── LICENSE / NOTICE / SECURITY.md / CONTRIBUTING.md / CODE_OF_CONDUCT.md
└── pyproject.toml

План развития

  • Фаза 1: MCP только для чтения (три бэкенда: demo + opac + oracle)

  • Фаза 2: Интеграция с реальными БД OPAC/Oracle, интеграция с объединённым каталогом консорциума (проверка контрактов + схема токенов)

  • Остатки Фазы 2: Docker-образ (не root, воспроизводимая сборка) + руководство по развёртыванию (включая шаблон аутентификации на уровне обратного прокси)

  • Опубликовано: тег v1.0.0 + GitHub Release (исходный код и документация; без CI/рабочих процессов, Docker-образ не собирается автоматически)

  • Развёртывание шлюза OAuth2/JWT для интеграции с кампусным CAS / единым порталом (шаблон готов, требуется настройка на месте)

  • Кандидаты на Фазу 2.5/3: подмножество только для чтения Huiwen ACS/SIP2 (оценка см. в docs/описание-и-оценка-интерфейсов-Huiwen-ACS-SIP2.md)

  • Фаза 3: Векторная база данных RAG + локальная LLM для интеллектуальных рекомендаций книг / справочной службы (см. docs/рекомендации-по-сервису-и-применению.md)

  • Фаза 4: Интеграция с OpenAPI новой платформы Huiwen


Лицензия и соответствие (Open Source & Compliance)

Рекомендация по версии лицензии с открытым исходным кодом

Для данного проекта рекомендуется использовать Apache License 2.0 (репозиторий уже содержит полный LICENSE):

  1. Пермиссивная (разрешительная): позволяет университетам, производителям и облачным платформам свободно использовать, модифицировать и распространять (включая коммерческое использование), требуется только сохранение уведомления об авторских правах и лицензионного заявления — способствует принятию AI-инструментами и сторонними системами.

  2. Патентная лицензия: Apache-2.0 явно предоставляет участникам патентную лицензию (статья 3), при совместном вкладе нескольких оргнизаций/сторон (консорциум университетов, технологических компаний) более ясна и устойчива к судебным искам.

  3. Стандартные условия для участников: неявное предоставление лицензии проекту (статья 5, Contribution Grant), избавляет от необхдимости каждому участнику подписыват отдельное CLA, соответствует практике публичных проектов на GitHub.

  4. Отличие: по сравению с MIT, Apache-2.0 больше подходит для официально выпущенных от имени организации инфраструктурных проектов, которые могут долгосрочно поддерживаться несколькими сторонами.

Если ваша организация предпочитает «минималистичный стиль», можно в любой момент вернуться к MIT: достаточно заменить полный текст LICENSE, изменить license в pyproject.toml обратно на { text = "MIT" } и обновить этот разел в README.

Соответствие требованиям (важно)

  • Не сдержит исходного кода проиводителей/третьих сторон: данный проект является независимым уровнем взаимодействия для закрытого Huiwen/Libsys, не включает никакого проприетарного кода Huiwen или консорциума; соглашения OPAC/консорциума основаны только на публичных протоколах веб-страниц и записях ответов реальных станций. Подробнее см. NOTICE.

  • Не публикует в репозитории никаких конфиденциальных данных для развертывания: реальные DSN, учетные данные, экземпляры для вхоа в OPAC, JWT консорциума, PII читателей, SECRET_KEY проиводителя не нахотятся в репозитории (SECURITY.md/CONTRUBTING.md установлены красные линии, строго зарещено внесение любых поозрительных конфиденциальных данных).

  • Товарные знаки: 汇文, Libsys, OPAC являются товарными знаками/названиями продуктов Jiangsu Huiwen Software и других правообладателей; данный репозиторий использует их толко для обозначения совместимости, не подразмевая одобрения или аффилировванности.

  • Перед использованием данного программного обеспечения, пожалуйста, уточните границы лицензирования и использования с Huiwen Software, обслуживающим консорциум и информационным центром вашего учреждения.


Устранение неполадок

Проблема

Решение

«Этот бэкенд не подерживается»

Проверьте HUIWEN_DATA_SOURCE; union_search достпен толко для бэкенда opac и требует включения конфигурации консорциума

Oracle DPY-3010 / ошибка подкючения

для 11g используйте HUIWEN_ORACLE_MODE=thick + HUIWEN_ORACLE_CLIENT_LIB_DIR (Instant Client)

Таймаут поска OPAC

Медленная реакция сайта (часто 15-40 с), увеличте HUIWEN_OPAC_TIMEOUT или повторите поытку позднее

union_search возвращает enabled:false

Консорциум не включён или отсуствует токен → включите конфигурацию и заполните JWT

Консорциум возвращает storage token not foud

JWT истёк → повторно войдите в OPAC, поучите getReaderJwt и обновтите токен

Фреймворк отказывется регистрировать инстремент (*args/**kwargs)

Функции инстремента долны имеь явные параметры; не используйте сигнатуру *args/**kwargs

Инструмент читателя возвращает «требуется маркер администратора»

Используйте токен из HUIWEN_AUTH_ADMIN_TOKENS

Available Tools

12 tools
browse_classificationB

中图法分类浏览:传入分类号前缀(如 'T')返回该类目馆藏统计。

ParametersJSON Schema
NameRequiredDescriptionDefault
tokenNo
prefixNo分类号前缀;为空返回各大类

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3.4/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It only states that the tool returns collection statistics, without confirming it is read-only, safe, or clarifying any side effects, auth requirements, or error handling. This is insufficient for a tool with no annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single short sentence, which is concise and front-loaded. However, it could be more structured by explicitly listing the parameters or adding a brief usage note. It is efficient but not maximally informative.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is simple, and an output schema exists, so the description does not need to explain return values. However, the description omits the token parameter entirely and lacks usage guidelines, making it incomplete for an agent to fully understand the tool's capabilities. It provides the core purpose but not enough context for correct invocation in all scenarios.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 50% (only prefix has a description). The tool description adds a concrete example for prefix ('如 'T'') and rephrases the schema description, but it does not explain the token parameter at all. While the example adds value, the missing token documentation leaves a gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'browse' (浏览) and resource 'Chinese Library Classification' (中图法分类), with the specific action of passing a classification prefix and returning collection statistics. It distinguishes itself from sibling tools like search_books and get_book_detail by focusing on classification-based browsing.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies when to use the tool: when you have a classification prefix to browse. However, it does not explicitly state when not to use it or provide alternatives, such as using search_books for keyword searches. The context of sibling tools provides some implicit guidance, but the description lacks direct usage instructions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_availabilityA

按 ISBN / 条码 / 题名查询馆藏复本在馆(可借)状态。

ParametersJSON Schema
NameRequiredDescriptionDefault
isbnNoISBN 号(优先)
titleNo题名(demo 后端支持;oracle 后端请用 search_books)
tokenNo
barcodeNo条码号(优先于 isbn 匹配)

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full behavioral burden. It conveys the tool is a read-only query for availability, which is reasonable. However, it does not disclose details such as whether it returns full availability per branch, pagination behavior, or rate limiting. With no annotations, more transparency would be beneficial.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence that front-loads the core purpose. It uses common separators (slashes) to list alternatives clearly. Every word contributes meaning without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has moderate complexity (4 params, 0 required) and an output schema exists (agents can infer return format from there), the description adequately covers the core purpose. It does not explain the token parameter or the exact response structure, but the output schema compensates. Minor gap is the lack of hint about how multiple search criteria interact (e.g., AND vs OR).

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is high at 75%, so the schema already documents ISBN, title, and barcode semantics well. The description repeats the search fields but adds no additional parameter-level guidance beyond what the schema provides. The token parameter's role remains unclear from both schema and description, preventing a higher score.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states this tool queries library copy availability by ISBN, barcode, or title. It uses a specific verb-resource combination ('查询馆藏复本在馆状态') that distinguishes it from siblings like search_books or get_book_detail.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context—to check availability—and the input schema provides a hint that for title queries with an Oracle backend, search_books should be used instead. However, there is no explicit when-to-use vs. when-not-to-use guidance for ISBN or barcode searches versus other tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_book_detailA

获取单册书目完整信息(含全部馆藏复本状态与流通统计)。

ParametersJSON Schema
NameRequiredDescriptionDefault
tokenNo
marc_noYesMARC 记录号(search_books 结果中的 marc_no)

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.5/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are present, so the description carries full burden. It states data retrieval but does not disclose whether this is a read-only operation, any authentication requirements, rate limits, or side effects. The behavioral disclosure is minimal and relies on inference.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence with zero waste. Every part contributes to defining the tool's purpose and key outputs.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the presence of an output schema and the tool's focused purpose (retrieve single book details with copy status and circulation), the description is largely complete. It could benefit from including when to use and behavioral notes, but is still adequate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 50% (one param documented, one not). The description adds no explanation for the undocumented 'token' parameter and does not elaborate on parameter semantics beyond what the schema provides. It does not compensate for the gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly specifies the verb (获取/get), the resource (单册书目完整信息/complete information of a single book), and explicitly lists included data (馆藏复本状态与流通统计). This uniquely distinguishes it from sibling tools like search_books, get_availability, and get_statistics.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage when complete single-book info with copy status and circulation is needed, but provides no explicit guidance on when to use this tool vs alternatives, nor any prerequisites or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_hot_booksA

热门借阅图书排行(可按中图法大类过滤)。

ParametersJSON Schema
NameRequiredDescriptionDefault
tokenNo
top_nNo返回条数(<=50)
cls_noNo中图法分类号前缀(如 'I')
periodNototal|yeartotal

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It does not mention side effects, authentication needs, rate limits, data freshness, or pagination behavior. The token parameter is left unexplained, and the description assumes a read-only ranking but does not explicitly confirm safety or data source.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise Chinese sentence that states the core function and filtering capability. It is front-loaded with the key purpose and has zero wasted words, making it easy for an agent to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the presence of an output schema (which presumably defines the return format), a simple parameter list with defaults, and a straightforward ranking task, the description covers the essential use case. However, it omits details like output ordering, how 'hot' is determined, and token handling, but the output schema may address some of this. It is nearly complete for a tool of this complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 75% with top_n, cls_no, and period having Chinese descriptions that specify constraints (≤50, prefix, total/year). The description adds minimal extra value beyond the schema by mentioning classification filtering, but token remains undocumented. Baseline is 3 due to high coverage, and no substantial semantic enrichment is provided.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: retrieving a ranking of hot borrowed books ('热门借阅图书排行') with optional filtering by Chinese library classification ('可按中图法大类过滤'). This directly distinguishes it from siblings like search_books (general search), get_new_arrivals (new arrivals), and browse_classification (browsing taxonomy) by focusing on popularity ranking.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies the tool is for obtaining a hot borrowing list with optional classification filtering, but it provides no explicit guidance on when to use it versus alternatives like search_books or get_statistics. There is no mention of prerequisites, auth requirements (despite the token parameter), or when not to use this tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_new_arrivalsC

近 N 天新书通报。

ParametersJSON Schema
NameRequiredDescriptionDefault
clcNo中图法分类号前缀过滤
daysNo时间范围(天)
tokenNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are present, so the description must fully disclose behavioral traits. The one-sentence description only states the tool's purpose; it does not mention whether it is a read-only operation, pagination, authentication requirements, or any side effects. This is insufficient for an agent to understand behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise (one sentence), which is efficient but lacks essential details. It is not structured with front-loading or bullet points. While brevity is valued, it sacrifices clarity and completeness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite the presence of an output schema, the description is too minimal to provide complete context. It does not explain what the output represents, how the parameters modify behavior, or any edge cases. For a tool with three parameters and no annotations, the description is insufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description adds no information about the three parameters. Although schema coverage is 67% (two parameters have descriptions in the schema), the tool description does not explain how 'clc' or 'days' affect results, and the 'token' parameter remains undocumented. The description fails to compensate for the missing schema description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description '近 N 天新书通报' (new book announcements for the last N days) clearly indicates the tool retrieves recently added books. The verb 'get' is implied by the name, and the resource is 'new arrivals'. While it is distinct from siblings like search_books or get_hot_books, it does not explicitly differentiate its scope or usage.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. The description does not mention prerequisites, context, or exclusions (e.g., when to use search_books instead). An agent has no information about the appropriate use case.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_reader_borrowingA

读者当前借阅(需 admin 认证令牌)。

ParametersJSON Schema
NameRequiredDescriptionDefault
tokenNo
cert_idYes读者证件号 CERT_ID
include_piiNo是否返回实名(默认脱敏/隐藏)

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description bears full responsibility for behavioral disclosure. It mentions the admin token requirement but fails to describe the response format, rate limits, or data privacy implications (e.g., the 'include_pii' parameter suggests sensitive data handling). With no annotations, crucial behavioral details like read-only nature or possible errors are missing.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is very concise (one short sentence) with no redundancy. It front-loads the core purpose ('读者当前借阅') and adds the critical auth requirement. However, it could be slightly more structured (e.g., separated into purpose and usage note) without losing brevity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 3 parameters (with 67% schema coverage), an output schema, and a clear sibling set, the description adequately signals the core function and auth need. However, it doesn't explain the return format or what happens when the token is missing, but the output schema likely covers return values. The complexity is moderate, and the description almost fully compensates for missing annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 67% (2 of 3 parameters have descriptions: 'cert_id' is described as '读者证件号 CERT_ID', and 'include_pii' has a clear explanation). The description adds context about the token being an admin auth requirement, which complements the schema. The 'include_pii' parameter's description in the schema is already informative, and the tool name implies purpose, so the remaining gap is minimal.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states '读者当前借阅' (reader's current borrowing) with the specific verb 'get' implied by the tool name and '需 admin 认证令牌' (requires admin auth token). It clearly distinguishes from siblings like 'get_reader_history' (historical borrowing) and 'get_reader_fines' (fines), making it unique among reader-related tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description mentions the need for an admin token and implies this is for current borrowing status. However, it does not explicitly exclude when to use alternatives like 'get_reader_history' for past records, nor does it provide clear context on prerequisites beyond the token. Still, the admin token requirement is a strong usage signal that helps the agent decide when to invoke this tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_reader_finesB

读者欠款 / 罚款明细(需 admin 认证令牌)。

ParametersJSON Schema
NameRequiredDescriptionDefault
tokenNo
cert_idYes读者证件号 CERT_ID
include_piiNo是否返回实名(默认脱敏/隐藏)

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must fully disclose behavioral traits. It mentions the need for an admin token, which hints at security/permission behavior. It does not disclose whether the operation is read-only, destructive, or has side effects. The parameter include_pii with default false suggests privacy behavior (data masking), but this is not explained in the description. With no annotations, a score of 3 reflects partial disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise (one short sentence in Chinese with a parenthetical note). It front-loads the core purpose and an important constraint. It could be slightly more structured or include an English explanation, but for a bilingual context it is efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema (so return values don't need explaining), 3 parameters, and no annotations, the description covers the core purpose and one critical constraint (admin token). It does not explain why include_pii exists or how to handle errors, but with the output schema and moderate complexity, this is reasonably complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 67% (2 out of 3 parameters documented: cert_id and include_pii). The description adds value beyond the schema by stating '需 admin 认证令牌' which implies the token parameter must be supplied with an admin-level token. It does not describe cert_id semantics further, but the schema already does that. The missing parameter (token) is implicitly addressed by the authentication hint in the description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses Chinese to state '读者欠款 / 罚款明细' meaning 'reader fines/fee details', which clearly indicates retrieving fine details for a reader. This distinguishes the tool from siblings like get_reader_borrowing (borrowing records) and get_reader_history (reading history). However, the verb is implicit, so it is not a perfect 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description adds '需 admin 认证令牌' meaning 'requires admin authentication token', which implies when to use the tool (must have admin rights). However, it provides no guidance on when not to use this tool or how it compares to siblings like get_statistics or union_search. The only usage hint is the authentication requirement, which is insufficient for an agent deciding among 12 sibling tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_reader_historyC

读者借阅历史(需 admin 认证令牌)。

ParametersJSON Schema
NameRequiredDescriptionDefault
tokenNo
cert_idYes读者证件号 CERT_ID
include_piiNo是否返回实名(默认脱敏/隐藏)

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description bears full responsibility. It states 'requires admin authentication token' but does not disclose whether the tool is read-only, what data it returns (history, pagination, etc.), or any potential side effects. This is insufficient for safe agent invocation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence. It conveys purpose and the critical admin requirement without wasted words. However, it is extremely brief, bordering on under specification, which reduces the score from 5.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite having 3 parameters, an output schema, and no annotations, the description only covers purpose and auth. It omits usage context, parameter guidance, and behavioral traits like read-only nature. For a tool with moderate complexity, this is incomplete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 67% (2 of 3 parameters have descriptions in the schema). The description adds no parameter information, such as explaining what cert_id represents or when include_pii should be true. Given moderate coverage, the description should at least echo parameter roles, which it fails to do.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description '读者借阅历史' clearly identifies the tool as retrieving a reader's borrowing history. It includes the admin authentication requirement, adding specificity. However, it does not explicitly distinguish from sibling get_reader_borrowing, which likely handles current borrows. The Chinese-only phrasing may limit understanding for non-Chinese agents, but the purpose is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this versus siblings like get_reader_borrowing or get_reader_fines. The only usage hint is the admin auth requirement, which is a prerequisite, not a selection criterion. An agent would need to infer from the name alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_statisticsD

馆藏统计。

ParametersJSON Schema
NameRequiredDescriptionDefault
tokenNo
metricNototal(总数)| by_location(按馆藏地)| by_clc(按分类)total
range_descNo统计时间范围描述(如 '2026')

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

D1.7/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are present, so the description carries the full burden of behavioral disclosure. It does not state whether the tool is read-only, requires authentication, has rate limits, or any side effects. The single phrase offers no transparency beyond a vague topic.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely short (four characters) but under-specified. It does not earn its place because it provides almost no useful information. True conciseness requires meaningful content, not mere brevity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has three parameters, an output schema, and multiple sibling tools, the description is grossly incomplete. It does not explain the return structure, parameter usage, or how to interpret the output. The agent cannot infer proper usage from this description alone.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description adds no meaning beyond the input schema. The schema already describes two of three parameters (metric and range_desc) with explicit options; the description does not summarize or clarify them. The token parameter lacks a schema description and the tool description does not help either. With 67% schema coverage, the description should compensate but fails to do so.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description '馆藏统计' (collection statistics) gives a vague sense of the tool's domain but lacks a specific verb or action. It does not clarify what the tool returns or how it differs from sibling tools like search_books or get_availability. The purpose is only marginally clearer than the tool name itself.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. There is no mention of context, prerequisites, or when not to use it. The description does not hint at any selective use cases, leaving the agent without decision support.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_system_statusB

返回当前数据源与后端健康状态。

ParametersJSON Schema
NameRequiredDescriptionDefault
tokenNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only states that it returns health status, but does not mention whether the optional token parameter is used for authentication, whether any side effects exist, or how health is determined. The behavior remains largely opaque beyond the basic return.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence with no filler, stating the core purpose efficiently. It is appropriately sized for a simple status tool, though it omits some detail. The structure is clean and direct.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite the simplicity of the tool (one optional parameter, output schema present), the description is incomplete because it fails to explain the token parameter and provides no behavioral context. The output schema mitigates return-format uncertainty, but the agent lacks enough information to confidently invoke the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema description coverage is 0%, and the description does not mention the 'token' parameter at all. The schema shows it is an optional string or null, but its purpose (e.g., authentication, context) is completely unexplained, leaving the agent to guess how to use it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description '返回当前数据源与后端健康状态。' clearly states a specific verb ('返回' = returns) and resource ('数据源与后端健康状态' = data source and backend health status). This distinct purpose sets it apart from sibling tools like search_books and get_book_detail, which are book-related queries.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit usage guidance or alternatives are provided. The purpose implies a system health check, and sibling tools are all book-related, which makes the intended usage inferable, but the description does not state when to use this tool (e.g., 'to verify backend health') or contrast it with alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_booksB

检索馆藏书目。返回题名/责任者/出版社/ISBN/馆藏地在馆信息列表。

ParametersJSON Schema
NameRequiredDescriptionDefault
clcNo中图法分类号前缀(如 'T'、'TP')
pageNo
sortNorelevance|circulation|daterelevance
fieldNoany|title|author|subject|publisher|isbn|callno|yearany
queryYes检索词
tokenNo
locationNo馆藏地代码
page_sizeNo
pub_year_maxNo
pub_year_minNo
in_library_onlyNo是否只返回有在馆复本的图书

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3.1/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only states 'search' and lists output fields, which implies a read-only operation but does not explicitly declare it. It does not mention authentication requirements, rate limits, side effects, or any constraints. For a search tool with 11 parameters, this is insufficient transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise: two sentences. The first sentence states the primary action, and the second lists the returned fields. Every word is functional, and the structure is front-loaded. There is no redundancy or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 11 parameters, an output schema exists, and there are 12 sibling tools, the description is too minimal. It does not explain pagination, field-specific search, date filtering, location filtering, or the token parameter. The agent would lack essential context to use the tool effectively, especially for non-trivial queries.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description adds no information about any of the 11 parameters. Schema coverage is 55% (6 parameters have descriptions in the schema), but the description does not compensate for the 5 parameters without descriptions (page, page_size, pub_year_min, pub_year_max, token). It also does not explain how the query parameter is interpreted (e.g., keyword matching, Boolean operators). The output description is helpful but does not aid parameter usage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's core function: searching the library catalog and returning a list of specific fields (title, author, publisher, ISBN, location, availability). The verb '检索' (search) is specific and the resource '馆藏书目' (library catalog) is well-defined. While it does not explicitly distinguish from siblings, the sibling tools are mostly specialized (detail, availability, hot, new, classification), making this the general search tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It does not mention any prerequisites, exclusions, or specific contexts. With 12 sibling tools including get_book_detail, browse_classification, and union_search, the lack of differentiation or usage hints leaves the agent to infer usage from the name alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

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

  1. 12 tool updatesv0.1.0
    • First observedbrowse_classification
    • First observedget_availability
    • First observedget_book_detail
    • First observedget_hot_books
    • First observedget_new_arrivals
    • First observedget_reader_borrowing
    • First observedget_reader_fines
    • First observedget_reader_history
    • First observedget_statistics
    • First observedget_system_status
    • First observedsearch_books
    • First observedunion_search

TDQS

B3.2/5.0

Scored across 12 tools

Disambiguation4/5

Most tools have clearly distinct purposes: book searching, detail retrieval, availability checking, hot books, new arrivals, classification browsing, statistics, system status, union search, and reader-specific operations. However, get_reader_borrowing, get_reader_history, and get_reader_fines all relate to reader accounts and could be conflated if descriptions were less precise, but their names clearly differentiate them.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern using snake_case: search_books, get_book_detail, get_hot_books, etc. The pattern is predictable and makes the toolset easy to navigate.

Tool Count5/5

With 12 tools, the count is well within the ideal range. The toolset covers public catalog operations, reader management, and system administration without being excessive or minimal.

Completeness3/5

The toolset provides comprehensive read-only access to library catalog and reader information. However, it is explicitly limited to read-only operations, lacking any write capabilities (e.g., placing holds, renewing items) which are natural expectations for a library system. The union_search tool's description also notes it does not implement interlibrary loan ordering, which is a gap.

Maintenance

ActivitySlowing
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • A
    license
    A
    quality
    D
    maintenance
    Read-only MCP server that connects AI clients to Crescender's school asset, loan, member, and asset-comms API.
    6
    MIT
  • A
    license
    A
    quality
    A
    maintenance
    Read-only MCP server that lets AI clients query DMS repositories through a local bridge, supporting tools for health checks, listing connections and items, retrieving item info, and reading documents. Credentials are handled securely via a separate broker.
    7
    MIT
  • F
    license
    Not graded
    quality
    C
    maintenance
    Read-only MCP server for AI clients to browse and search project files securely, with configurable permissions, virtual paths, and key-based access.
    -
  • F
    license
    B
    quality
    C
    maintenance
    A secure, read-only MCP server that enables AI assistants to inspect transactions, vendor performance, wallet balances, and analytics through validated REST API calls.
    19
    -