Skip to content
vibyverse
Programs
vibe-qcvibe-viewervibe-sketchervibe-schedulerQVFSoftware overview
NewsResearchDownloadsSupportDocumentation ↗GitHub ↗
Ko-fi
Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Command compatibility: Use vibe-sketcher with release 0.6.4 or later. Older archives use vibe-sketch; the deprecated alias remains supported with no removal date. vq is unchanged. Compatibility guide.
vibe-sketcher documentation
Documentationvibe-sketcher
0.7.2

Getting started

  • Installation
  • Desktop app
  • Supporter recognition and website updates
  • Quickstart
  • Troubleshooting
  • Tutorials
    • Your first molecule
    • A reaction sketch
    • Draw a reaction, publish the figure and run it with vibe-qc
    • From sketch to a vibe-qc calculation input
    • Solid-state inputs: MgO, an Al₂O₃ slab and benzene on top
    • Draw and publish a Diels–Alder reaction
    • Annotate mechanisms and connect reaction steps
    • Exchange structures and keep calculation results intact
    • Check stereochemistry, properties, names and spin
    • Clean the drawing and prepare 3D geometry
    • Generate every supported vibe-qc task
    • Portable geometry and optional ORCA inputs
    • Follow, cancel and reopen vibe-qc calculations
    • Reproduce a reaction with CLI, Python, REST and MCP
    • Open, edit and save in the desktop app
    • Use the keyboard and compact palette
    • Find a worked example for a feature
    • Reproduce the tutorial illustrations
  • Runnable examples
  • Figures for papers
  • The browser app
  • Find drawn atoms
  • Transfer a selected structure to vibe-viewer
  • Review drawing proposals
  • Compound, fragment and named-reaction library
  • Drawing cleanup
  • Nanostructures
  • Nanocarbon research workflows
  • Surfaces, electrodes and nanoparticles
  • Solid-state and surface reaction authoring plan
  • Solid-state input builder plan
  • Crystal Builder feature comparison
  • Periodic structures and interchange
  • Periodic bond graphs and crystal preparation
  • Reticular frameworks from drawn building blocks
  • Guest loading in periodic hosts
  • Powder diffraction planning
  • Porosity plans
  • Porous and negative-curvature carbon models
  • Amorphous polymer boxes and membranes
  • Coated and disordered CNT fibre composites
  • Solid-state and surface reaction schemes
  • Interfaces, stacking faults and extended defects
  • CNT–linker–metal junctions
  • Periodic scans, phonons and equations of state
  • Solid-state structures and inputs
  • AICCM planning (experimental)
  • Cyclic topology, figure math and multi-panel figures
  • Periodic interchange formats
  • Crystal templates
  • Electrode reactions
  • Redox and finite-cluster binding recipes
  • Tidy scheme
  • Results and reaction energies
  • Working with agents

Reference

  • The document format
  • File formats
  • Input writers
  • Calculation runs
  • Command line
  • REST API
  • Python API
    • vibesketcher.document
      • vibesketcher.document.abbreviations
      • vibesketcher.document.apparatus
      • vibesketcher.document.bilbao
      • vibesketcher.document.build_review
      • vibesketcher.document.campaign
      • vibesketcher.document.campaign_results
      • vibesketcher.document.cdx
      • vibesketcher.document.cdxml
      • vibesketcher.document.cif_import
      • vibesketcher.document.clean
      • vibesketcher.document.cnt_composites
      • vibesketcher.document.cnt_junctions
      • vibesketcher.document.coordinates
      • vibesketcher.document.core_potentials
      • vibesketcher.document.counterpoise
      • vibesketcher.document.counterpoise_recipes
      • vibesketcher.document.crystal
      • vibesketcher.document.crystal_templates
      • vibesketcher.document.derive
      • vibesketcher.document.diffraction
      • vibesketcher.document.diffraction_model
      • vibesketcher.document.diffraction_store
      • vibesketcher.document.displacements
      • vibesketcher.document.draft_session
      • vibesketcher.document.draft_worker
      • vibesketcher.document.drafts
      • vibesketcher.document.electrochem
      • vibesketcher.document.electrochemical_recipes
      • vibesketcher.document.embed
      • vibesketcher.document.enumeration
      • vibesketcher.document.eos
      • vibesketcher.document.external_results
      • vibesketcher.document.formats
      • vibesketcher.document.generics
      • vibesketcher.document.geometry_return
      • vibesketcher.document.guest_loading
      • vibesketcher.document.highlights
      • vibesketcher.document.interfaces
      • vibesketcher.document.io
      • vibesketcher.document.ket
      • vibesketcher.document.kpath
      • vibesketcher.document.measured_patterns
      • vibesketcher.document.model
      • vibesketcher.document.monomers
      • vibesketcher.document.multiple_groups
      • vibesketcher.document.nanostructures
      • vibesketcher.document.nmr
      • vibesketcher.document.orca
      • vibesketcher.document.periodic
      • vibesketcher.document.periodic_capabilities
      • vibesketcher.document.periodic_formats
      • vibesketcher.document.periodic_graph
      • vibesketcher.document.periodic_prepare
      • vibesketcher.document.periodic_recipes
      • vibesketcher.document.polymer_packing
      • vibesketcher.document.porosity
      • vibesketcher.document.porosity_store
      • vibesketcher.document.properties
      • vibesketcher.document.property_data
      • vibesketcher.document.queries
      • vibesketcher.document.qvf
      • vibesketcher.document.reaction_library
      • vibesketcher.document.recipe
      • vibesketcher.document.relax
      • vibesketcher.document.renders
      • vibesketcher.document.results
      • vibesketcher.document.review
      • vibesketcher.document.rgfile
      • vibesketcher.document.schema
      • vibesketcher.document.scheme
      • vibesketcher.document.sequences
      • vibesketcher.document.slab
      • vibesketcher.document.solid_balance
      • vibesketcher.document.solid_build
      • vibesketcher.document.solid_edit
      • vibesketcher.document.solid_energetics
      • vibesketcher.document.solid_reaction_model
      • vibesketcher.document.solid_reactions
      • vibesketcher.document.solids
      • vibesketcher.document.spacegroups
      • vibesketcher.document.spectra
      • vibesketcher.document.stereo
      • vibesketcher.document.stoichiometry
      • vibesketcher.document.surfaces
      • vibesketcher.document.symmetry
      • vibesketcher.document.symmetry_ops
      • vibesketcher.document.tables
      • vibesketcher.document.template_library
      • vibesketcher.document.tlc
      • vibesketcher.document.transfer
      • vibesketcher.document.wyckoff
    • vibesketcher.chem
      • vibesketcher.chem.analysis
      • vibesketcher.chem.cip
      • vibesketcher.chem.clean
      • vibesketcher.chem.depiction
      • vibesketcher.chem.embed
      • vibesketcher.chem.endpoints
      • vibesketcher.chem.fire
      • vibesketcher.chem.formula
      • vibesketcher.chem.frameworks
      • vibesketcher.chem.layered_carbon
      • vibesketcher.chem.layout
      • vibesketcher.chem.mapping
      • vibesketcher.chem.nanostructures
      • vibesketcher.chem.nanotube_cells
      • vibesketcher.chem.perceive
      • vibesketcher.chem.periodic_geometry
      • vibesketcher.chem.porous_carbon
      • vibesketcher.chem.query_worker
      • vibesketcher.chem.relax
      • vibesketcher.chem.report
      • vibesketcher.chem.reticular
      • vibesketcher.chem.rolled_tubes
      • vibesketcher.chem.species
    • vibesketcher.naming
      • vibesketcher.naming.opsin
    • vibesketcher.render
      • vibesketcher.render.chemfig
      • vibesketcher.render.cyclic_topology
      • vibesketcher.render.diagram
      • vibesketcher.render.diffraction
      • vibesketcher.render.fonts
      • vibesketcher.render.mathtext
      • vibesketcher.render.nanostructures
      • vibesketcher.render.panels
      • vibesketcher.render.periodic
      • vibesketcher.render.periodic_tex
      • vibesketcher.render.porosity
      • vibesketcher.render.porosity_table
      • vibesketcher.render.publication
      • vibesketcher.render.scene
      • vibesketcher.render.schematic
      • vibesketcher.render.solid_reactions
      • vibesketcher.render.styles
      • vibesketcher.render.surfaces
      • vibesketcher.render.symmetry_elements
      • vibesketcher.render.vector
    • vibesketcher.inputs
      • vibesketcher.inputs.aiccm
      • vibesketcher.inputs.base
      • vibesketcher.inputs.neb
      • vibesketcher.inputs.orca
      • vibesketcher.inputs.orca_keywords
      • vibesketcher.inputs.qcschema
      • vibesketcher.inputs.recipe
      • vibesketcher.inputs.registry
      • vibesketcher.inputs.vibeqc
      • vibesketcher.inputs.vibeqc_periodic
      • vibesketcher.inputs.xyz
    • vibesketcher.queue
    • vibesketcher.viewer
    • vibesketcher.server
      • vibesketcher.server.aiccm
      • vibesketcher.server.build_review
      • vibesketcher.server.cnt_composites
      • vibesketcher.server.cnt_junctions
      • vibesketcher.server.diffraction
      • vibesketcher.server.documents
      • vibesketcher.server.drafts
      • vibesketcher.server.figures
      • vibesketcher.server.guard
      • vibesketcher.server.guest_loading
      • vibesketcher.server.interfaces
      • vibesketcher.server.periodic_graph
      • vibesketcher.server.periodic_recipes
      • vibesketcher.server.polymer_packing
      • vibesketcher.server.porosity
      • vibesketcher.server.porous_carbon
      • vibesketcher.server.reticular
      • vibesketcher.server.solid_reactions
      • vibesketcher.server.store
      • vibesketcher.server.symmetry_ops
      • vibesketcher.server.wyckoff
    • vibesketcher.agent
      • vibesketcher.agent.client
      • vibesketcher.agent.mcp
      • vibesketcher.agent.mcp_build_review
      • vibesketcher.agent.mcp_cnt_composites
      • vibesketcher.agent.mcp_diffraction
      • vibesketcher.agent.mcp_figures
      • vibesketcher.agent.mcp_periodic_recipes
      • vibesketcher.agent.mcp_polymer_packing
      • vibesketcher.agent.mcp_porosity
      • vibesketcher.agent.mcp_porous_carbon
      • vibesketcher.agent.mcp_solid_reactions
      • vibesketcher.agent.mcp_symmetry_ops
    • vibesketcher.codenames
    • vibesketcher.elements
    • vibesketcher.units
  • Security and input bounds
  • Performance and accessibility checks
  • Compatibility and user-evaluation protocol
  • Release-paper evaluation protocol
  • Periodic paper workflows

The project

  • How to cite
  • Roadmap
  • vibe-sketcher and vibe-viewer: responsibilities
  • Canvas spike: Ketcher behind the adapter
  • Release codenames
  • Licences
  • Release process
  • Changelog
Back to top
vibe-sketcher/Documentation

vibesketcher.agent.mcp_diffraction¶

MCP tools for powder diffraction planning (#207).

Each tool is a call to the REST routes in vibesketcher.server.diffraction; tools() is joined to the list in vibesketcher.agent.mcp.make_tools().

Functions

tools(client, document_id)

vibesketcher.agent.mcp_diffraction.tools(client, document_id)[source]¶
Parameters:
  • client (RestClient)

  • document_id (Callable[[dict[str, Any]], str])

Return type:

list[Tool]

Next
vibesketcher.agent.mcp_figures
Previous
vibesketcher.agent.mcp_cnt_composites
Copyright © 2026, Michael F. Peintinger
Made with Sphinx and @pradyunsg's Furo
All Vibyverse manualsSupport the tools
On this page
  • vibesketcher.agent.mcp_diffraction
    • tools()