trackmcp
Back to directory
Levis0045

ntealan-apis-mcp-server

View on GitHub

A modular, extensible Model Context Protocol (MCP) server for NTeALan REST APIs dictionaries and contributions. This project provides a unified interface for managing dictionary data, articles, and user contributions, and is designed for easy integration and extension.

0 stars PythonAI & Machine Learning Updated May 1, 2025
generative-ailexicographymcp-serverntealansse-server

Documentation


🦜 Table of Contents


🦜 Features

  • Dictionary Management: Create, update, delete, and retrieve dictionaries and their metadata.
  • Article Management: Manage articles within dictionaries, including statistics and filtering.
  • Contribution Management: Track and manage user contributions to articles and dictionaries.
  • Extensible MCP Server: Easily add new resources and tools.
  • Async Support: Built on top of `fastmcp` and `aiohttp` for high performance.
  • OpenAPI-like Resource Registration: Register resources and tools with URIs and tags.

🦜 Getting Started

Prerequisites

Installation

Installing via pip

Clone the repository and install dependencies:

bash
git clone https://github.com/Levis0045/ntealan-apis-mcp-server.git
cd ntealan-apis-mcp-server
pip install .

(Optional) Install and use uv for faster dependency management

If you want faster installs and modern Python packaging, you can use uv in the `ntealan-apis-mcp-server` directory:

bash
uv sync

Running the Server

To start the MCP server:

bash
python -m ntealanmcp -t stdio

Or, if you have uv installed, you can run server command:

bash
ntealanmcp -t stdio

The server will run using the `Server-Sent Events (sse)` transport by default at this endpoint `http://127.0.0.1:8000/sse`. You can modify the transport in `main.py` if needed.


🦜 Project Structure

code
ntealan-api/
β”œβ”€β”€ src/
β”‚   └── ntealan_apis_mcp/
β”‚       β”œβ”€β”€ main.py
β”‚       β”œβ”€β”€ models/
β”‚       β”‚   β”œβ”€β”€ article.py
β”‚       β”‚   β”œβ”€β”€ contribution.py
β”‚       β”‚   β”œβ”€β”€ dictionary.py
β”‚       β”‚   └── common.py
β”‚       β”œβ”€β”€ primitives/
β”‚       |    β”œβ”€β”€ resources/
β”‚       β”‚    β”‚   β”œβ”€β”€ article.py
β”‚       β”‚    β”‚   β”œβ”€β”€ contribution.py
β”‚       β”‚    β”‚   └── dictionary.py
β”‚       |    └── tools/
β”‚       |        β”œβ”€β”€ article.py
β”‚       |        β”œβ”€β”€ contribution.py
β”‚       |        └── dictionary.py
β”‚       └── common/
β”‚           β”œβ”€β”€ utils.py
β”‚           β”œβ”€β”€ cache.py
β”‚           └── http_session.py
β”œβ”€β”€ examples/
β”œβ”€β”€ tests/
β”œβ”€β”€ pyproject.toml
└── requirements.txt

🦜 Usage

Primitive resources

Resources are asynchronous functions that expose public Data from NTeALan API endpoints for dictionaries, articles, and contributions. They are registered with the MCP server and can be called via their custom URIs.

Example resource registration:

python
ntl_mcp_server.add_resource_fn(
    lambda dictionary_id, article_id, params: get_article_by_id(
        dictionary_id, article_id, params, ntl_mcp_server.get_context()
    ),
    name="get_article_by_id",
    uri="ntealan-apis://articles/dictionary/{dictionary_id}/{article_id}?{params}",
    tags=["article-endpoint", "mcp-resource"],
    mime_type="application/json",
    description="Get an article by ID"
)

# or just use the classic integration
@ntl_mcp_server.resource(
    uri="ntealan-apis://articles/dictionary/{dictionary_id}/{article_id}?{params}",
    tags=["article-endpoint", "mcp-resource"],
    mime_type="application/json"
)
async def get_article_by_id(
    dictionary_id: str, article_id: UUID,
    params: str, ctx: Context
) -> McpResourceResponse:
    """
    Retrieve a article by its unique identifier.
    """
    # Placeholder logic
    return {"status": "OK", "data": f"Hello, {article_id}!"}

List of existings resources and status:

Name / URI PatternDescriptionParametersDevelopment Status
`ntealan-apis://dictionaries/dictionary/{dictionary_id}`Get dictionary metadata by ID`dictionary_id`Stable
`ntealan-apis://dictionaries?limit=2`Get all dictionaries metadata`limit`Stable
`ntealan-apis://dictionaries/statistics/{dictionary_id}`Get statistics for a specific dictionary`dictionary_id`Stable
`ntealan-apis://dictionaries/statistics`Get statistics for all dictionariesNoneStable
`ntealan-apis://articles/dictionary/{dictionary_id}/{article_id}?none`Get article by ID`dictionary_id`, `article_id`Stable
`ntealan-apis://articles?limit=2`Get all articles`limit`Stable
`ntealan-apis://articles/dictionary/{dictionary_id}?limit=2`Get all articles for a dictionary`dictionary_id`, `limit`Stable
`ntealan-apis://articles/statistics/{dictionary_id}`Get article statistics for a dictionary`dictionary_id`Stable
`ntealan-apis://articles/statistics`Get statistics for all articlesNoneNot stable
`ntealan-apis://contributions/{dictionary_id}/{contribution_id}`Get contribution by ID`dictionary_id`, `contribution_id`Stable
`ntealan-apis://greeting/Elvis`Greeting resource`name`Stable
`ntealan-apis://articles/dictionaries/search/{dictionary_id}?q=mba&page=1&limit=1`Search articles in a dictionary`dictionary_id`, `q`, `page`, `limit`Stable
`ntealan-apis://articles/search?q=mba&page=1`Search articles`q`, `page`Stable
`ntealan-apis://dictionaries/search?q=yemb&page=1&limit=1`Search dictionaries`q`, `page`, `limit`Stable

Primitive tools

Tools are utility functions for creating, updating, and deleting dictionaries, articles, and contributions.

Example tool registration:

python
ntl_mcp_server.add_tool(
    create_dictionary,
    description="Create a new dictionary",
    tags=["mcp-tool", "dictionary-endpoint"]
)

List of existings tools and status (NOT YET IMPLEMENTED):

Tool NameDescriptionRequired Payload FieldsDevelopment Status
`create_dictionary`Create a new dictionary`data` (dictionary fields)Not started
`update_dictionary`Update an existing dictionary`dictionary_id`, `data` (fields to update)Not started
`delete_dictionary`Delete a dictionary`dictionary_id`Not started
`create_article`Create a new article`dictionary_id`, `data` (article fields)Not started
`update_article`Update an article`dictionary_id`, `article_id`, `data` (fields to update)Not started
`delete_article`Delete an article`dictionary_id`, `article_id`Not started
`create_contribution`Create a new contribution`dictionary_id`, `article_id`, `data` (contribution fields)Not started
`update_contribution`Update a contribution`dictionary_id`, `article_id`, `contribution_id`, `data`Not started
`delete_contribution`Delete a contribution`dictionary_id`, `article_id`, `contribution_id`Not started

Run examples

Check `examples/` folder to run and test some samples.

bash
# for all resources
uv run examples/run_client_resources.py -t sse -e prod -s 8
# for all tools
uv run examples/run_client_tools.py -t stdio -e local -s 0

You can get docs on :

bash
# for all resources
uv run examples/run_client_resources.py -h
# for all tools
uv run examples/run_client_tools.py -h

Deploying with Docker

You can deploy the MCP server using Docker and serve it behind an Nginx reverse proxy for production environments.

1. Build the Docker image

Build the Docker image manually:

bash
docker build -t ntealan-mcp-server .

2. Or automatically build and start the service

  • Get and check the latest version of compose and Docker. You will get in response `Docker Compose version v2.35.1`.
bash
docker compose version
  • Build and start the service
bash
docker compose up --build -d
  • Your MCP server will now be accessible at this address `http://0.0.0.0:8000` or your configured domain.
  • Connect with MCP Client at `http://127.0.0.1:8000/sse` or your configured domain.

Connect with Smithery

  • Install mcp cli
bash
uv add "mcp[cli]"
  • Connect with MCP client
python
import mcp
from mcp.client.websocket import websocket_client
import json
import base64

smithery_api_key = "your-api-key"
url = f"wss://server.smithery.ai/@Levis0045/ntealan-apis-mcp-server/ws?api_key={smithery_api_key}"

async def main():
    # Connect to the server using websocket client
    async with websocket_client(url) as streams:
        async with mcp.ClientSession(*streams) as session:
            # Initialize the connection
            await session.initialize()
            # List available tools
            tools_result = await session.list_tools()
            print(f"Available tools: {', '.join([t.name for t in tools_result.tools])}")

            # Example of calling a tool:
            # result = await session.call_tool("tool-name", arguments={"arg1": "value"})

if __name__ == "__main__":
    import asyncio
    asyncio.run(main())

🦜 Contributing

Get more informations in this file: CONTRIBUTION.md

🦜 Contact

[pypi-badge]: https://img.shields.io/pypi/v/mcp.svg

[pypi-url]: https://pypi.org/project/ntealan_apis_mcp/

[mit-badge]: https://img.shields.io/pypi/l/mcp.svg

[mit-url]: https://github.com/Levis0045/ntealan-apis-mcp-server/blob/v1/LICENSE

[docs-badge]: https://img.shields.io/badge/docs-modelcontextprotocol.io-blue.svg

[docs-url]: https://raw.githubusercontent.com/Levis0045/ntealan-apis-mcp-server/refs/heads/v1/README.md

[spec-url]: https://github.com/Levis0045/ntealan-apis-mcp-server/blob/v1/README.md

[python-url]: https://www.python.org/downloads/

Frequently asked questions

What is ntealan-apis-mcp-server?

ntealan-apis-mcp-server is A modular, extensible Model Context Protocol (MCP) server for NTeALan REST APIs dictionaries and contributions. This project provides a unified interface for managing dictionary data, articles, and user contributions, and is designed for easy integration and extension.

How do I install ntealan-apis-mcp-server?

Open the GitHub repository and follow its README. Most MCP servers are added to your client's MCP config, then called by your agent.

Is ntealan-apis-mcp-server open source?

Yes β€” it is hosted on GitHub at https://github.com/Levis0045/ntealan-apis-mcp-server.

Related MCP tools

Run your own MCP server? See who uses it and what to fix.

Measure it with TrackMCP