CBN
- other
17
GitHub Stars
other
Language
6 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"zfinix-cbn_mcp": {
"command": "/path/to/cbn_mcp",
"args": []
}
}
}You run a Central Bank of Nigeria (CBN) MCP Server to access CBN data and circulars from your AI assistants. This server exposes tools for circulars, exchange rates, and financial data, and can be connected to MCP-compatible apps like Cursor or Claude Desktop to answer questions with up-to-date regulatory information.
How to use
Connect to your MCP client of choice and start the CBN MCP Server. The server provides a set of tools to retrieve circulars, exchange rates, and financial data, as well as status and utility endpoints. Use these tools in natural language prompts to fetch data, generate summaries, or perform regulatory analyses. Access to PDFs of circulars is available for download, and you can format results for large language models when needed.
Practical usage patterns include: retrieving the latest circulars for a date range, looking up a specific circular by ID, downloading a circular PDF, listing exchange rates for a given period, and querying current monetary policy metrics. You can also request summaries or regulatory analysis prompts tailored for compliance review.
How to install
Prerequisites you need installed on your machine before running the server:
-
Dart SDK (version compatible with the server build)
-
Git for cloning the repository
Installation steps you should follow if you want to run the server locally:
-
Clone the project repository to your workstation
-
Change directory into the project folder
-
Install dependencies with Dart
-
Generate any necessary mappable classes if your setup requires it
-
Run the server directly with Dart or build an executable for distribution
Configuration and startup notes
Two standard ways to run the server are shown for MCP clients. Choose one method that fits your workflow and ensure the path or command is accessible on your system.
{
"name": "cbn-mcp",
"command": "/path/to/cbn_mcp",
"args": []
}
Additional configuration examples
If you prefer running via Dart, you can start with a command like this from your project directory:
{
"name": "cbn-mcp-dart",
"command": "dart",
"args": ["run", "bin/main.dart"],
"cwd": "/path/to/cbn_mcp"
}
Security and access considerations
Ensure that you protect access to the MCP server endpoints and control who can query sensitive monetary policy or official data. Use secure channels for HTTP endpoints and restrict access in your network environment as needed.
Usage examples
After starting the server, you can ask your AI assistant to fetch data such as the latest circulars, exchange rates for specific dates, or specific financial metrics. For example: “Show me the most recent CBN circulars for this month” or “What is the USD/NGN rate today?”
Notes on integration with MCP clients
The server exposes a set of tools that cover circulars, exchange rates, and financial data. You can also fetch circular PDFs and obtain URLs for direct downloads. For analysis, you can generate prompts designed for LLM workflows, or request summaries and regulatory analyses directly through your MCP client.
Troubleshooting
If your MCP client cannot connect, verify that the server process is running and listening on the expected port or stdio endpoint. Check network permissions and ensure the correct command path is used in your client configuration.
Notes
This MCP server is designed to be used with Cursor, Claude Desktop, or any MCP-compatible application to access CBN data and circulars efficiently in AI conversations.
Available tools
getAllCirculars
Fetch all CBN circulars with optional filtering by date range and category.
getCircularById
Get a specific CBN circular by its ID.
searchCirculars
Search CBN circulars by title or description keywords.
fetchCircularPdf
Download and read PDF content of CBN circulars.
fetchCircularPdfById
Download PDF content by circular ID.
getCircularPdfUrl
Get the direct download URL for a CBN circular PDF by its ID.
getCircularsForLLMAnalysis
Get recent CBN circulars with PDF URLs formatted for LLM analysis.
getAllExchangeRates
Fetch all CBN exchange rates with optional filtering by date range and currency.
getExchangeRateById
Get a specific CBN exchange rate by its ID.
getAllFinancialData
Fetch all CBN financial data with optional filtering by date range and financial metrics.
getFinancialDataById
Get a specific CBN financial data by its ID.
cbnApiStatus
Current status and health of the CBN API connection.
serverInfo
Information about this CBN MCP server.
availableCircularPdfs
List of available circular PDFs with their URIs.
randomFact
A random fact about the CBN.
circularSummary
Generate a summary prompt for CBN circulars analysis.
regulatoryAnalysis
Generate prompts for regulatory compliance analysis of CBN circulars.