roshan-alefba-mcp
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| ROSHAN_ALEFBA_TOKEN | No | API token for the default instance (shorthand mode). | |
| ROSHAN_ALEFBA_BASE_URL | No | Base URL of the default Alefba instance (shorthand mode). | https://alefba.roshan-ai.ir |
| ROSHAN_ALEFBA__LOG_LEVEL | No | Log level. | INFO |
| ROSHAN_ALEFBA__DEFAULT_INSTANCE | No | Instance used when a call omits 'instance'. | default |
| ROSHAN_ALEFBA__INSTANCES__<NAME>__TOKEN | No | Token for instance <NAME> (nested mode). | |
| ROSHAN_ALEFBA__INSTANCES__<NAME>__TIMEOUT | No | Request timeout in seconds for instance <NAME> (nested mode). | 60 |
| ROSHAN_ALEFBA__INSTANCES__<NAME>__BASE_URL | No | Base URL for instance <NAME> (nested mode). Replace <NAME> with an instance name. | |
| ROSHAN_ALEFBA__INSTANCES__<NAME>__VERIFY_SSL | No | Verify TLS for instance <NAME> (nested mode). | true |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": false
} |
| prompts | {
"listChanged": false
} |
| resources | {
"subscribe": false,
"listChanged": false
} |
| experimental | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| alefba_read_documentA | Read (OCR) a document or image from a URL. استخراج متن از سند یا تصویر با آدرس اینترنتی. By default the call blocks (wait=true) and returns the full structured result {document_url, pages:[{page_url,width,height,angle,text,parts:[...]}]} where each box is 'left top width height' in pixels. Set wait=false to queue the job and get {state, task_ids} back, then poll with alefba_get_result. type is one of general, ID-card, excel; priority is 1 (highest) to 4 (lowest). Pass an optional task_id to fetch a queued result. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_read_document_uploadA | Upload a local file and read (OCR) it. بارگذاری فایل محلی و استخراج متن آن. Sends the file as multipart form data (field 'document') to Alefba with the same options as alefba_read_document. Returns the structured OCR result, or {state, task_ids} when wait=false. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_get_resultA | Fetch or poll the result of an async document read. دریافت نتیجه پردازش ناهمگام با شناسه کار. Pass a task_id returned by alefba_read_document(wait=false). If the job is still running you get {state} (e.g. pending); when done you get the full document result. Set wait=true to block server-side until completion. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_read_pagesA | Read (OCR) specific pages of documents. استخراج متن از صفحات مشخص اسناد. Each entry in page_urls is a document URL with an @page=N suffix, e.g. https://example.com/doc.pdf@page=2. Returns the same structured result as alefba_read_document (or {state, task_ids} async). Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_read_document_callbackA | Read a document and receive the result via webhook (callback). پردازش سند و دریافت نتیجه از طریق وبهوک. Instead of polling, Alefba POSTs the result to callback_url when done. Returns {state:'processing', document_url} immediately. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_list_documentsA | List documents known to an Alefba instance, page by page. فهرست اسناد موجود در سرویس الفبا. Calls GET /api/list_documents/?page=N and returns {results:[{url, thumbnail, indexed_in_bazz, processed_pages, page_count, analyzed, processed_diff, type, filename}], num_pages}. Use num_pages to iterate; page defaults to 1. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_document_statusA | Report processing progress for one or more documents. گزارش وضعیت پردازش اسناد. Calls POST /api/document_status/ and returns a mapping of each URL to {analyzed, processed_pages, all_pages} so you can track async jobs. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_document_pagesA | List the page URLs that make up a previously uploaded document. فهرست صفحات یک سند بارگذاریشده. Calls POST /api/document_pages/ and returns {document_url, pages:[page_url, ...]}. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_detail_documentC | Fetch full detail for a document (thumbnails, page URLs, pages, type). دریافت جزئیات کامل یک سند. Calls POST /api/detail_document/ and returns {document_url, thumbnail, thumbnails:[...], page_urls:[...], pages:[...], document_type}. May start processing any remaining pages of the document. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_delete_documentA | Delete a previously uploaded document and its results. حذف سند بارگذاریشده و نتایج آن. Calls POST /api/delete_document/ and returns {message} confirming deletion. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_download_originalA | Get a signed link to download a document's ORIGINAL source file. دریافت پیوند دانلود فایل اصلی سند. Calls POST /api/download_original/ and returns {download_link}. The link is signed and short-lived (expires ~30s) and only works for already-processed local files. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_download_wordA | Download the analyzed document as a Word (.docx) file. دریافت سند تحلیلشده به صورت فایل ورد. Calls POST /api/download_word/. Returns the download endpoint info; when save_path is given the .docx bytes are saved locally and the saved path is returned. The document must have been processed first. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_download_excelA | Download the analyzed document as an Excel (.xlsx) file. دریافت سند تحلیلشده به صورت فایل اکسل. Calls POST /api/download_excel/. The document must have been processed with type=excel. Returns download info, or the saved path when save_path is provided. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| alefba_download_pdfA | Download the analyzed document as a searchable PDF. دریافت سند به صورت پیدیاف قابلجستوجو. Calls POST /api/download_pdf/. quality controls image quality (0-100), color toggles colour vs. grayscale, and img_format (png|jpg) sets the embedded image format. Returns download info, or the saved path when save_path is provided. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| healthcheckA | Check that an Alefba instance is up and ready. بررسی سلامت سرویس الفبا. Calls Alefba's GET /api/healthcheck/ readiness probe and returns {status, message}, e.g. {"status": "ok", "message": "Server is up and ready"}. Optional name of the configured Alefba instance to target. Omit to use the default instance. |
| list_instancesA | List the configured Alefba instances (names and base URLs only). فهرست نمونههای پیکربندیشده الفبا. Useful for discovering which 'instance' values the other tools accept. Returns {default_instance, instances:[{name, base_url, verify_ssl}]}. Tokens are NEVER returned. |
| roshan_alefba_docsA | Return documentation about Alefba (الفبا) OCR and these MCP tools. راهنمای سرویس الفبا و ابزارهای این سرور. Use this to learn what the server does, which tools exist, and where to read the official docs (https://docs.roshan-ai.ir) before calling other tools. Pass an optional topic to filter to one tool or doc link. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Latest Blog Posts
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/dwin-gharibi/roshan-alefba-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server