{"id":31814431,"url":"https://github.com/timescale/tiger-docs-mcp-server","last_synced_at":"2025-10-11T08:49:25.974Z","repository":{"id":315304971,"uuid":"1025052801","full_name":"timescale/tiger-docs-mcp-server","owner":"timescale","description":"MCP server to expose an API around our embedded docs database","archived":false,"fork":false,"pushed_at":"2025-10-06T18:25:09.000Z","size":252,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-06T18:39:01.046Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timescale.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-23T16:40:10.000Z","updated_at":"2025-10-06T18:25:12.000Z","dependencies_parsed_at":"2025-09-17T21:45:07.521Z","dependency_job_id":"af4f8f92-a7d7-4848-a5f0-68b0b469b60c","html_url":"https://github.com/timescale/tiger-docs-mcp-server","commit_stats":null,"previous_names":["timescale/tiger-docs-mcp-server"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/timescale/tiger-docs-mcp-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftiger-docs-mcp-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftiger-docs-mcp-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftiger-docs-mcp-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftiger-docs-mcp-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timescale","download_url":"https://codeload.github.com/timescale/tiger-docs-mcp-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftiger-docs-mcp-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279006642,"owners_count":26084150,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-11T08:49:24.982Z","updated_at":"2025-10-11T08:49:25.969Z","avatar_url":"https://github.com/timescale.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tiger Docs MCP Server\n\nAn [MCP server](https://modelcontextprotocol.io/docs/learn/server-concepts) that supercharges AI assistants with deep PostgreSQL, TimescaleDB, and Tiger Cloud knowledge through semantic documentation search and curated prompt templates. \n\n## Quick Start\n\nWant to use this MCP Server without running it yourself? Use the publicly available endpoint hosted by TigerData! [https://mcp.tigerdata.com/docs](https://mcp.tigerdata.com/docs)\n\n**Claude Code** installation: \n\n```bash\nclaude mcp add --transport http tiger-docs https://mcp.tigerdata.com/docs\n```\n\n**Cursor** installation:\n\n```bash\n// .cursor/mcp.json\n{\n  \"mcpServers\": {\n    \"tiger-docs\": {\n      \"url\": \"https://mcp.tigerdata.com/docs\"\n    }\n  }\n}\n```\n\n## API\n\nAll methods are exposed as MCP tools and REST API endpoints.\n\n### Semantic Search - PostgreSQL Documentation\n\nSearches the PostgreSQL documentation for relevant entries based on semantic similarity to the search prompt.\n\n**MCP Tool**: `semantic_search_postgres_docs`\n**REST Endpoint**: `GET /api/semantic-search/postgres-docs`\n\n#### Input\n\n```jsonc\n{\n  \"prompt\": \"What is the SQL command to create a table?\",\n  \"version\": 17,  // optional, default is 17 (supports versions 14-18)\n  \"limit\": 10     // optional, default is 10\n}\n```\n\n#### Output\n\n```jsonc\n{\n  \"results\": [\n    {\n      \"id\": 11716,\n      \"content\": \"CREATE TABLE ...\",\n      \"metadata\": \"{...}\",  // JSON-encoded metadata\n      \"distance\": 0.407     // lower = more relevant\n    }\n    // ...more results\n  ]\n}\n```\n\n### Semantic Search - Tiger Docs\n\nSearches the TigerData and TimescaleDB documentation using semantic similarity.\n\n**MCP Tool**: `semantic_search_tiger_docs`\n**REST Endpoint**: `GET /api/semantic-search/tiger-docs`\n\n#### Input\n\n```jsonc\n{\n  \"prompt\": \"How do I set up continuous aggregates?\",\n  \"limit\": 10  // optional, default is 10\n}\n```\n\n#### Output\n\nSame format as PostgreSQL semantic search above.\n\n### Prompt Templates\n\nRetrieves curated prompt templates for common PostgreSQL and TimescaleDB tasks.\n\n**MCP Tool**: `get_prompt_template`\n\n#### Input\n\n```jsonc\n{\n  \"name\": \"setup_hypertable\"  // see available prompt templates in tool description\n}\n```\n\n#### Output\n\n```jsonc\n{\n  \"name\": \"setup_hypertable\",\n  \"title\": \"TimescaleDB Complete Setup\",\n  \"description\": \"Step-by-step instructions for designing table schemas and setting up TimescaleDB with hypertables, indexes, compression, retention policies, and continuous aggregates.\",\n  \"content\": \"...\"  // full prompt template content\n}\n```\n\n**Available Prompt Templates**: Check the MCP tool description for the current list of available prompt templates.\n\n## Development\n\nClone the repo.\n\n```bash\ngit clone git@github.com:timescale/tiger-docs-mcp-server.git\n```\n\n### Configuration\n\nCreate a `.env` file based on the `.env.sample` file.\n\n```bash\ncp .env.sample .env\n```\n\nAdd your OPENAI_API_KEY to be used for generating embeddings.\n\n### Run a TimescaleDB Database\n\nYou will need a database with the [pgvector extension](https://github.com/pgvector/pgvector).\n\n#### Using Tiger Cloud\n\nUse the [tiger CLI](https://github.com/timescale/tiger-cli) to create a Tiger Cloud service.\n\n```bash\ntiger service create --free --with-password -o json\n```\nCopy your database connection parameters into your .env file.\n\n#### Using Docker\n\nRun the database in a docker container.\n\n```bash\n# pull the latest image\ndocker pull timescale/timescaledb-ha:pg17\n\n# run the database container\ndocker run -d --name tiger-docs \\\n  -e POSTGRES_PASSWORD=password \\\n  -e POSTGRES_DB=tsdb \\\n  -e POSTGRES_USER=tsdbadmin \\\n  -p 127.0.0.1:5432:5432 \\\n  timescale/timescaledb-ha:pg17\n```\n\nCopy your database connection parameters to your .env file:\n\n```dotenv\nPGHOST=localhost\nPGPORT=5432\nPGDATABASE=tsdb\nPGUSER=tsdbadmin\nPGPASSWORD=password\n```\n\n### Building the MCP Server\n\nRun `npm i` to install dependencies and build the project. Use `npm run watch` to rebuild on changes.\n\n### Loading the Database\n\nThe database is NOT preloaded with the documentation. To make the MCP server usable, you need to scrape, chunk, embed, load, and index the documentation.\nFollow the [directions in the ingest directory](/ingest/README.md) to load the database.\n\n### Testing\n\nThe MCP Inspector is a very handy to exercise the MCP server from a web-based UI.\n\n```bash\nnpm run inspector\n```\n\n| Field          | Value           |\n| -------------- | --------------- |\n| Transport Type | `STDIO`         |\n| Command        | `node`          |\n| Arguments      | `dist/index.js` |\n\n#### Testing in Claude Desktop\n\nCreate/edit the file `~/Library/Application Support/Claude/claude_desktop_config.json` to add an entry like the following, making sure to use the absolute path to your local `tiger-docs-mcp-server` project, and real database credentials.\n\n```json\n{\n  \"mcpServers\": {\n    \"tiger-docs\": {\n      \"command\": \"node\",\n      \"args\": [\n        \"/absolute/path/to/tiger-docs-mcp-server/dist/index.js\",\n        \"stdio\"\n      ],\n      \"env\": {\n        \"PGHOST\": \"x.y.tsdb.cloud.timescale.com\",\n        \"PGDATABASE\": \"tsdb\",\n        \"PGPORT\": \"32467\",\n        \"PGUSER\": \"readonly_mcp_user\",\n        \"PGPASSWORD\": \"abc123\",\n        \"DB_SCHEMA\": \"docs\",\n        \"OPENAI_API_KEY\": \"sk-svcacct\"\n      }\n    }\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimescale%2Ftiger-docs-mcp-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimescale%2Ftiger-docs-mcp-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimescale%2Ftiger-docs-mcp-server/lists"}