Skip to main content
Unstructured Foundation is an Early Access product. Unstructured must accept you into the Early Access program before you can begin using Foundation. Add your name to the Early Access interest list.Unstructured is currently accepting a limited number of participants into the Early Access program at its discretion, with plans to expand access to a more general audience in the future.The following information is being provided to give you an advance preview of possible future functionality. Unstructured makes no express claims as to what extent this information will reflect the state of the product upon initial general availability.

​
Requirements

Before you begin, you must have the following:

​
Set up Foundation

  1. From your terminal, add the Foundation MCP server plugin marketplace: 
    codex plugin marketplace add Unstructured-IO/unstructured-foundation-marketplace
    If prompted, sign in to the Codex CLI.
  2. Use the marketplace you just added to install the Foundation MCP server: 
    codex plugin add foundation@unstructured-foundation
  3. Use the installed Foundation MCP server to sign in to Foundation. To do this, run the following command: 
    codex mcp login foundation
  4. A web browser tab will appear, prompting you to authenticate with Foundation. Follow the on-screen instructions to finish authenticating.

​
Connect to and index your source

  1. From within a Codex CLI session in your terminal, prompt with the following: 
    $foundation:connect
  2. Click the link that appears in the response. If the link does not appear, go to the following link in your web browser instead: https://foundation.unstructured.io/connect
  3. If prompted, sign in to Foundation.
  4. The Connect sources to use Foundation page appears. Connecting to a new source from the Codex CLI If this page does not appear after you sign in to Foundation, click the New Source button to show a page with similar functionality.
  5. Click one of the available sources, and then click Connect.
  6. Follow the on-screen directions to finish connecting to your source.
  7. View the source files’ ingestion and indexing job’s progress. To do this, on the sidebar, click Summary.
  8. Wait until the source’s tile displays Fully indexed.
  9. You can now start using the Codex CLI to work with the generated index. For example, you can ask the Codex CLI questions such as the following: 
    What is a summary of the kinds of information that are available in the Unstructured Foundation index about my sources?

    What are some examples of the kinds of questions I can ask the Unstructured Foundation index about my sources?

​
Next steps

  • To learn more about how to use Unstructured Foundation, enter the following prompt in the Codex CLI: $foundation:help
  • Manage your Foundation sources: Add, change, and remove sources from Foundation.
  • Foundation storage: Understand what artifacts that Foundation generates, indexes, and stores about your sources.
  • Troubleshoot Foundation: Solutions for common issues.

​
Questions? Need help?