What is Dev Portal

The dev-portal is the Chainstack Developer Portal, a documentation hub that provides resources and references for developers working with Chainstack’s services.

Use cases

Use cases for the dev-portal include developers looking to integrate Chainstack services into their applications, teams needing to collaborate on API usage, and educational purposes for learning about blockchain technologies.

How to use

You can use the dev-portal by browsing and searching through its content. The RPC node API reference is interactive, allowing users to experiment with API calls. Additionally, it can be integrated with agents and local MCP servers using Mintlify CLI.

Key features

Key features include an interactive RPC node API reference, public access for agents to ingest documentation, automatic generation of llms-full.txt, and the ability to run a local MCP server with a simple command.

Where to use

The dev-portal is used in software development, particularly in blockchain and decentralized application development, where developers need comprehensive documentation and API references.

Chainstack Developer Portal

This is the repository for the Chainstack Developer Portal.

The Developer Portal runs on Mintlify—the same docs engine as used by Anthropic & Cursor, so if you ever used those, you’ll feel right at home.

Using the Developer Portal

You can use the Developer Portal by just browsing and searching through it as you would normally. Note that the RPC node API reference is interactive, so feel free to play around with the calls.

Since we are in the age of AI and LLMs, here are three additional ways to use the Developer Portal with agents:

• This repository is public, so your agents can just ingest it.
• llms-full.txt is automatically generated and published on every change.
• Built-in MCP server — just run npx @mintlify/mcp@latest add chainstack to add the Developer Portal as a local MCP server.

Note that the Developer Portal MCP server is a docs project and is different from an RPC node MCP server that we are also building.

MCP server

Built-in MCP server — just run npx @mintlify/mcp@latest add chainstack to add the Developer Portal as a local MCP server.

Contributing to the Developer Portal

Just contribute as you normally would—PRs, Issues, Discussions, whatever works best for you. We welcome every and all builders.

Adding release notes

The release notes structure might be a bit convoluted to figure out at first glance, so here’s a step-by-step walkthrough:

The structure:

dev-portal/
├── changelog.mdx
├── docs.json
└── changelog/
   ├── chainstack-updates-may-30-2025.mdx
   ├── chainstack-updates-april-1-2025.mdx
   ├── chainstack-updates-march-4-2025.mdx
   ├── chainstack-updates-february-5-2025.mdx
   └── chainstack-updates-january-7-2025.mdx

You need to work with each of these files to create proper release notes (order is not important):

1. In changelog.mdx, copy the previous entry within the <Update...> </Update> tags (and including these tags) and paste it on top of the previous entry.

Example:

<Update label="Chainstack updates: May 30, 2025" description=" by Ake" >

**Protocols**. Now, you can deploy [Global Nodes](https://raw.githubusercontent.com/chainstack/dev-portal/master//docs/global-elastic-node) for Unichain Mainnet. See also [Unichain tooling](https://raw.githubusercontent.com/chainstack/dev-portal/master//docs/unichain-tooling) and a [tutorial](https://raw.githubusercontent.com/chainstack/dev-portal/master//docs/unichain-collecting-uniswapv4-eth-usdc-trades).

<Button href="/changelog/chainstack-updates-may-30-2025">Read more</Button>
</Update>

Edit the entry to make it your piece of the release notes.

Make sure you change the dates properly in the update label and in the button label.

2. In the changelog/ directory, copy or create a file in the proper format. Example chainstack-updates-may-30-2025.mdx. In the file, paste in the same entry (without the <Updates> tag) that you did in the changelog.mdx file.
3. In docs.json, in the Release notes section, add the newly created file name (without .mdx) between changelog and the previous release notes entries. This will let the docs pick up the release notes file and properly display it.

Example:

       "tab": "Release notes",
        "pages": [
          "changelog",
          "changelog/chainstack-updates-may-30-2025",
          "changelog/chainstack-updates-may-16-2025",

And you are done.

Run mintlify dev and do a quick local visual check.

Run mint broken-links for a quick links check.

And submit your PR.

Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of your documentation (where docs.json is)

mintlify dev

Dead links check

A CI job will check each PR and warn on the dead links.

You can also run the dead links check locally before submitting your PR:

mint broken-links

Running locally is much more convenient and much faster than a CI job.

Troubleshooting

• Mintlify dev isn’t running - Run mintlify install it’ll re-install dependencies.
• Page loads as a 404 - Make sure you are running in a folder with docs.json