site_name: Scholar MCP Server
site_url: https://pvliesdonk.github.io/scholar-mcp/
site_description: FastMCP server for Semantic Scholar with OpenAlex enrichment and docling PDF conversion
repo_url: https://github.com/pvliesdonk/scholar-mcp
repo_name: pvliesdonk/scholar-mcp
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  # Generates llms.txt + llms-full.txt for the README badge.
  # Sections mirror `nav:` below — keep them aligned when customising
  # (both blocks are sentinel-protected so customise both as a unit).
  - llmstxt:
      full_output: llms-full.txt
      markdown_description: >
        scholar-mcp is a FastMCP server for Semantic Scholar with OpenAlex
        enrichment and docling PDF conversion. It exposes 13 tools for paper
        search, citation graph traversal, recommendations, and PDF-to-Markdown
        conversion over the Model Context Protocol.
      sections:
        # PROJECT-LLMSTXT-SECTIONS-START — keep aligned with `nav:` below;
        # kept across copier update.
        Getting Started:
          - index.md: Overview — features, architecture, and quick start
          - installation.md: Installation from PyPI, uv, Docker, or Linux packages
          - configuration.md: All environment variables with types and defaults
        Guides:
          - guides/index.md: Guide overview — which guide to read
          - guides/claude-desktop.md: Claude Desktop setup (basic, API key, PDF, OpenAlex)
          - guides/authentication.md: Authentication modes — bearer token, OIDC, and troubleshooting
          - guides/pdf-conversion.md: PDF conversion with docling-serve and VLM enrichment
          - guides/citation-graphs.md: Citation graph traversal, bridge papers, and caching
          - guides/file-exchange.md: MCP File Exchange convention for passing files between co-deployed servers
        Tools:
          - tools/index.md: All 13 MCP tools with parameters, return values, and usage tips
        Deployment:
          - deployment/docker.md: Docker Compose with docling-serve, Traefik, volumes, UID/GID
          - deployment/systemd.md: systemd service — package install, security hardening
          - deployment/oidc.md: OIDC authentication setup with Authelia
        # PROJECT-LLMSTXT-SECTIONS-END
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_bases: true
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2
            members_order: source
            docstring_style: google
            merge_init_into_class: true
            show_if_no_docstring: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - tables
  - toc:
      permalink: true
  - attr_list
  - md_in_html

exclude_docs: |
  superpowers/
  plans/
  specs/
  design.md

nav:
  # PROJECT-NAV-START — replace with your real navigation; kept across copier
  # update. Keep aligned with the `llmstxt` plugin's sentinel-protected
  # `sections:` block above.
  - Home: index.md
  - Installation: installation.md
  - Configuration: configuration.md
  - Tools:
      - Overview: tools/index.md
  - Guides:
      - Overview: guides/index.md
      - Claude Code Plugin: guides/claude-code-plugin.md
      - Claude Desktop: guides/claude-desktop.md
      - Authentication: guides/authentication.md
      - PDF Conversion: guides/pdf-conversion.md
      - Citation Graphs: guides/citation-graphs.md
      - File Exchange: guides/file-exchange.md
  - Deployment:
      - Docker: deployment/docker.md
      - systemd: deployment/systemd.md
      - OIDC Authentication: deployment/oidc.md
  # PROJECT-NAV-END
