Sachverhalt:
A. A.a Die IV-Stelle des Kantons Solothurn wies das Rentenbegehren der 1954 geborenen J._ ab, was das Versicherungsgericht des Kantons Solothurn mit Entscheid vom 14. April 2003 bestätigte. Aufgrund der von der Versicherten im September 2003 geltend gemachten Verschlechterung des Gesundheitszustandes gab die Verwaltung das psychiatrische Gutachten des Dr. K._ vom 22. März 2004 in Auftrag. Mit Verfügung vom 29. April 2004 lehnte sie das Leistungsbegehren ab und hielt daran mit Einspracheentscheid vom 9. November 2004 fest. Das Versicherungsgericht des Kantons Solothurn wies die dagegen erhobene Beschwerde mit Entscheid vom 12. Dezember 2005 ab. Auf Verwaltungsgerichtsbeschwerde hin hob das damalige Eidgenössische Versicherungsgericht mit Urteil vom 26. Mai 2006 den angefochtenen vorinstanzlichen Entscheid und den Einspracheentscheid vom 9. November 2004 auf und wies die Sache an die Verwaltung zurück, damit sie nach Abklärungen im Sinne der Erwägungen über den Anspruch auf eine Rente der Invalidenversicherung neu verfüge.
A.b Die IV-Stelle holte daraufhin den Bericht des Dr. R._ vom 26. August 2006 ein. Zudem ordnete sie am 5. Oktober 2006 eine erneute medizinische Abklärung durch Dr. K._ an und gewährte der Versicherten das rechtliche Gehör. Mit Schreiben vom 26. Oktober 2006 machte ihr Rechtsvertreter geltend, die Begutachtung habe durch einen neuen, mit der Sache bisher nicht befassten Facharzt zu erfolgen. Die IV-Stelle hielt in der Folge an der Begutachtung durch Dr. K._ fest und weigerte sich, dem Antrag auf Erlass einer anfechtbaren Verfügung stattzugeben.
B. Am 6. Dezember 2006 liess J._ beim Versicherungsgericht des Kantons Solothurn Rechtsverweigerungsbeschwerde einreichen mit dem Antrag, die IV-Stelle sei zu verpflichten, über die geltend gemachten Ausstands- und Ablehnungsgründe gegenüber Dr. med. K._ zu verfügen. Dieses wies mit Entscheid vom 21. Februar 2007 die Beschwerde (Dispositiv-Ziffer 1) und das Gesuch um Gewährung der unentgeltlichen Rechtspflege (Dispositiv-Ziffer 2) ab; Verfahrenskosten wurden keine erhoben (Dispositiv-Ziffer 3).
C. Mit Beschwerde lässt J._ beantragen, in Aufhebung des vorinstanzlichen Entscheids sei die IV-Stelle zu verpflichten, eine beschwerdefähige Zwischenverfügung betreffend der von ihr geltend gemachten Ausstands- und Ablehnungsgründe gegen den vorgesehenen Gutachter Dr. K._ zu erlassen. Zudem ersucht sie um Gewährung der unentgeltlichen Prozessführung für das letztinstanzliche Verfahren und um unentgeltliche Verbeiständung für das vorinstanzliche wie auch für das Verfahren vor Bundesgericht.
Die IV-Stelle schliesst auf Abweisung der Beschwerde. Das Bundesamt für Sozialversicherungen hat sich nicht vernehmen lassen.
D. Am 20. August 2008 hat das Bundesgericht eine publikumsöffentliche Beratung durchgeführt.
Erwägungen:
1. Die Beschwerde in öffentlich-rechtlichen Angelegenheiten (Art. 82 ff. BGG) kann wegen Rechtsverletzung gemäss Art. 95 f. BGG erhoben werden. Das Bundesgericht wendet das Recht von Amtes wegen an (Art. 106 Abs. 1 BGG). Es darf nicht über die Begehren der Parteien hinausgehen (Art. 107 Abs. 1 BGG).
2. 2.1 Streitig und zu prüfen ist, ob die IV-Stelle mittels einer anfechtbaren Zwischenverfügung über die Einholung eines nochmaligen psychiatrischen Gutachtens bei Dr. K._ hätte befinden müssen, wovon die Beschwerdeführerin unter Hinweis auf die von ihr geltend gemachten Ausstands- und Ablehnungsgründe ausgeht, während IV-Stelle und Vorinstanz dies verneinen.
2.2 Der Anordnung einer Begutachtung durch den Sozialversicherer kommt rechtsprechungsgemäss kein Verfügungscharakter zu. Einwendungen gegen Sachverständige sind in Form einer selbstständig anfechtbaren Zwischenverfügung zu behandeln, sofern substanziierte gesetzliche Ausstandsgründe geltend gemacht werden, währenddessen Rügen, welche über die gesetzlichen Ausstandsgründe hinausge-hen, im Rahmen der Beweiswürdigung Rechnung zu tragen ist (BGE 132 V 93 E. 5 und 6 S. 100 ff., 376 E. 2.5 S. 378).
3. 3.1 Im Beschwerdeverfahren, welches zum Urteil vom 26. Mai 2006 führte, liess die Beschwerdeführerin den Beweiswert des Gutachtens des Dr. K._ vom 22. März 2004 beanstanden und eventualiter beantragen, die Sache sei zur weiteren Abklärung an die Vorinstanz zurückzuweisen. In der Begründung wurde ausgeführt, es sei entweder eine neue Begutachtung anzuordnen, oder es seien zumindest bei Dr. K._ ergänzende Erkundigungen einzuholen, insbesondere zur abweichenden Haltung gegenüber Dr. R._ und zur Klärung der aufgezeigten Widersprüche.
3.2 Mit Urteil vom 26. Mai 2006 entsprach das Gericht dem beschwerdeführerischen Eventualantrag auf nochmalige psychiatrische Begutachtung. Dabei hat es erwogen, Dr. K._ habe die Gründe nicht dargelegt, weshalb auf die Feststellungen und Schlussfolgerungen des behandelnden Psychiaters Dr. R._ und des Hausarztes Dr. M._ nicht abgestellt werden könne. Zudem bestehe eine erklärungsbedürftige Diskrepanz zwischen dem Gutachten des Dr. K._ und jenem der Abklärungsstelle X._ vom 8. April 2002. Überdies hätten sieben der zehn von Dr. K._ durchgeführten Tests wegen fehlender Deutschkenntnisse trotz Anwesenheit einer Übersetzerin nicht ausgewertet werden können, wobei diese laut Hausarzt zur Beurteilung der Krankheit und Erhebung des Psychostatus wichtig gewesen wären. Der Test auf Persönlichkeitsstörung habe Hinweise auf histerione und paranoide Persönlichkeitszüge ergeben. Akzentuierte (histerione, paranoide) Persönlichkeitszüge seien unter den Diagnosen mit Auswirkungen auf die Arbeitsfähigkeit aufgezählt. Widersprüchlich oder zumindest erklärungsbedürftig sei, dass Dr. K._ bei der Frage nach zumutbaren Tätigkeiten vollumfänglich auf das Gutachten der Abklärungsstelle X._ verweise, wo indessen histerione und paranoide Persönlichkeitszüge unter den Diagnosen mit Auswirkung auf die Arbeitsfähigkeit nicht erwähnt worden seien. Dies führte das Gericht zum Schluss, dass sich aufgrund der bei den Akten liegenden medizinischen Unterlagen nicht beurteilen lasse, ob sich der Gesundheitsschaden der Versicherten seit der Verfügung vom 13. Dezember 2002 bis zum Einspracheentscheid vom 9. November 2004 in anspruchserheblicher Weise verschlechtert habe und ob sich dies auf die zumutbare Arbeitsfähigkeit auswirke.
4. 4.1 Das kantonale Gericht ging davon aus, das Bundesgericht habe dem Gutachten des Dr. K._ einzig wegen der festgestellten materiellen Mängel den Beweiswert abgesprochen, während an der Person des Gutachters in jenem Verfahren keinerlei Kritik geübt worden sei. Die notwendige Objektivität und Sachlichkeit sei nie in Frage gestanden. Vom Facharzt dürfe daher verlangt werden, dass er mit der nötigen Professionalität an die Abklärungen herangehe und die Akten sowie das Urteil vom 26. Mai 2006 in seine Begutachtung einbeziehe, zumal die Versicherte keine konkreten Einwände vorbringe, welche Zweifel an dessen Fähigkeiten erwecken würden. Nachdem weder der Begründung noch dem Dispositiv des bundesgerichtlichen Rückweisungsentscheids zu entnehmen sei, dass das erforderliche psychiatrische Gutachten bei einem andern Facharzt in Auftrag zu geben sei, erweise sich die Anordnung einer erneuten Begutachtung durch Dr. K._ als rechtmässig. Da dagegen lediglich Einwendungen materieller Natur vorgebracht würden, habe die IV-Stelle zu Recht keine Zwischenverfügung erlassen.
4.2 Die Beschwerdeführerin macht geltend, da das Gutachten des Dr. K._ vom Bundesgericht als nicht schlüssig und folglich qualitativ ungenügend bezeichnet worden sei, bestehe die Gefahr der Befangenheit, wenn derselbe Psychiater noch einmal ein Gutachten erstelle. Dieser könne versucht sein, die zweite Expertise möglichst in Einklang mit der ersten zu bringen. Da damit ein Ausstandsgrund geltend gemacht werde, sei die IV-Stelle verpflichtet, darüber mittels einer Zwischenverfügung zu befinden.
5. 5.1 Die materiellen (inhaltlichen) Anforderungen an die zu erstattende ärztliche Expertise ergeben sich aus dem im Einzelfall zur Diskussion stehenden Beweisgegenstand in Verbindung mit den darauf bezogenen Fragestellungen. Erscheint dem zuständigen Justizorgan die Schlüssigkeit einer Expertise in wesentlichen Punkten zweifelhaft, hat es nötigenfalls ergänzende Beweise zur Klärung dieser Zweifel zu erheben. Dafür können sich namentlich eine Ergänzung des bestehenden Gutachtens oder die Anordnung eines neuen Gutachtens, allenfalls einer Oberexpertise anbieten. Das Abstellen auf eine nicht schlüssige Expertise im Rahmen der Beweiswürdigung kann Verstösse gegen das Willkürverbot oder gegen die Verfahrensrechte der Parteien nach sich ziehen (vgl. BGE 130 I 337 E. 5.4.2 S. 346; 129 I 49 E. 4 S. 57 f.; 118 Ia 144 E. 1c S. 146 f.). Welche Art von Gutachten anzuordnen ist (Zweitgutachten [Obergutachten] oder Ergänzungsgutachten), ist eine Ermessensfrage (Urteil 6B_283/2007 vom 5. Oktober 2007, E. 2).
5.2 Ergänzende Gutachten sind einzuholen, wenn die Würdigung des bereits erstatteten Gutachtens ergeben hat, dass einzelne der behandelten Punkte einer erneuten sachverständigen Stellungnahme bedürfen oder wenn bestimmte Fragen ausserhalb des gutachterlich bereits abgehandelten Bereichs abzuklären sind (Ueli Kieser, Die rechtliche Würdigung von medizinischen Gutachten, in: René Schaffhauser/ Franz Schlauri [Hrsg.], Rechtsfragen der medizinischen Begutachtung in der Sozialversicherung, St. Gallen 1997, S. 157 f.). Nach der Rechtsprechung ist grundsätzlich nichts dagegen einzuwenden, dass ein Gutachter seine Feststellungen im späteren Verfahren ergänzt oder im Lichte neuer Tatsachen oder erhobener Einwendungen prüft, soweit dabei das bereits erstattete Gutachten zum Ausgangspunkt der weiteren Untersuchungen und Ausführungen gemacht wird (RKUV 1985 Nr. K 646 S. 235, E. 5b). Ein Zweitgutachten steht im Vordergrund, wenn das Gericht ein bestehendes Gutachten für klar unzureichend und kaum verwertbar erachtet (Urteil 6B_283/2007 vom 5. Oktober 2007, E. 2) oder wenn es die Würdigung der vorhandenen, gegensätzlich lautenden gutachterlichen Stellungnahmen nicht erlaubt, auf eine derselben abzustellen, weil die Kenntnis fehlt, eine der beiden vertretenen Auffassungen als schlüssig und nachvollziehbar zu bezeichnen (Ueli Kieser, a.a.O., S. 158 f.).
6. 6.1 Nach der materiell unverändert von Art. 58 aBV in Art. 30 Abs. 1 BV überführten, ebenfalls in Art. 6 Ziff. 1 EMRK enthaltenen Garantie des verfassungsmässigen Richters hat der Einzelne Anspruch darauf, dass seine Sache von einem unparteiischen, unvoreingenommenen und unbefangenen Richter ohne Einwirken sachfremder Umstände entschieden wird. Liegen bei objektiver Betrachtungsweise Gegebenheiten vor, die den Anschein der Befangenheit und die Gefahr der Voreingenommenheit zu begründen vermögen, so ist die Garantie verletzt (BGE 127 I 196 E. 2b S. 198 mit Hinweisen). Für Sachverständige gelten grundsätzlich die gleichen Ausstands- und Ablehnungsgründe, wie sie für Richterinnen und Richter vorgesehen sind (BGE 120 V 357 E. 3a S. 364). Da sie nicht Mitglied des Gerichts sind, richten sich die Anforderungen zwar nicht nach Art. 30 Abs. 1 BV, sondern nach Art. 29 Abs. 1 BV. Hinsichtlich der Unparteilichkeit und Unbefangenheit kommt Art. 29 Abs. 1 BV indessen ein mit Art. 30 Abs. 1 BV weitgehend übereinstimmender Gehalt zu (BGE 127 I 196 E. 2b S. 198).
6.2 Vorbefassung begründet nicht zwingend den Anschein der Befangenheit. Nach der Rechtsprechung kann ein Sachverständiger nicht allein deshalb abgelehnt werden, weil er den Exploranden schon früher einmal begutachtet hat (BGE 132 V 93 E. 7.2.2 S. 110). Als massgebendes Kriterium für die Beurteilung dieser Frage im Einzelfall hielt das Bundesgericht fest, es sei generell zu fordern, dass das Verfahren in Bezug auf den konkreten Sachverhalt und die konkret zu entscheidenden Rechtsfragen trotz der Vorbefassung als offen erscheine und nicht der Anschein der Vorbestimmtheit erweckt werde (BGE 117 Ia 182 E. 3b S. 184 mit Hinweis). Es ist somit danach zu fragen, ob das Ergebnis der Begutachtung nach wie vor als offen und nicht vorbestimmt erscheint. Kann die Offenheit bejaht werden, ist die Besorgnis der Voreingenommenheit trotz Vorbefassung unbegründet (Regina Kiener/Melanie Krüsi, Die Unabhängigkeit von Gerichtssachverständigen, in: ZSR 2006 S. 506). Dies ist beispielsweise der Fall, wenn der Experte andere Fragen zu beantworten oder sein erstes Gutachten lediglich zu erklären, zu erläutern oder zu ergänzen hat, nicht aber, wenn er die Schlüssigkeit seiner früheren Expertise zu überprüfen oder objektiv zu kontrollieren hat (Urteil 2A.259/1998 vom 30. November 1998).
7. 7.1 Aus den Urteilserwägungen des Rückweisungsentscheids vom 26. Mai 2006 wird ersichtlich, dass es im Rahmen der Neubegutachtung in erster Linie um eine Klärung von nach Vorliegen des Gutachtens des Dr. K._ vom 22. März 2004 offen gebliebenen Fragen geht. Das Gericht präzisierte nicht, dass die nochmalige psychiatrische Begutachtung durch einen bisher mit der Versicherten nicht befassten Facharzt vorzunehmen sei. Es liess auch in keiner Weise durchblicken, es gehe davon aus, Dr. K._ habe sich in seiner Beurteilung bereits auf eine Meinung festgelegt und komme daher für die nochmalige psychiatrische Begutachtung nicht mehr in Frage. Davon ging offensichtlich auch die Beschwerdeführerin in der Beschwerdeschrift vom 30. Januar 2006 nicht aus, sonst hätte sie im damaligen Verfahren nicht eine erneute Untersuchung durch Dr. K._ und dessen Beantwortung von Ergänzungsfragen verlangt. Auch der regionalärztliche Dienst der IV-Stelle nahm in der Stellungnahme vom 4. Oktober 2006 an, dem Psychiater seien die sich aus dem Urteil vom 26. Mai 2006 ergebenden Zusatzfragen zu unterbreiten. Während die Versicherte gegen die Einholung des Berichts des behandelnden Psychiaters Dr. R._ vom 26. August 2006 nichts einzuwenden hatte, liess sie am 26. Oktober 2006, nachdem die IV-Stelle ihr Gelegenheit gegeben hatte, sich zur Person des zu beauftragenden Dr. K._ zu äussern, erstmals und ohne dass neue Erkenntnisse hinzugekommen wären, die darauf schliessen liessen, dass Dr. K._ objektiv betrachtet den Anforderungen an die erneute psychiatrische Expertise nicht gerecht werden könnte, geltend machen, dieser sei in der Sache befangen. Dazu hat sich die IV-Stelle am 2. November 2006 in ablehnendem Sinne geäussert. Ob sie damit faktisch über die geltend gemachte Befangenheit verfügt hat, braucht nicht abschliessend beurteilt zu werden.
7.2 Die Aufgabe des Dr. K._ besteht in erster Linie darin, sein erstes Gutachten im Sinne der im Urteil des Eidg. Versicherungsgerichts vom 26. Mai 2006 festgestellten Unvollständigkeiten zu überarbeiten und sich insbesondere mit dem Gutachten der Abklärungsstelle X._ vom 8. April 2002 und weiteren bei den Akten liegenden Arztberichten vertiefter auseinanderzusetzen. Es stellen sich im damaligen Gutachten nicht beantwortete Fragen, die vom Gericht nicht selber überprüft werden können und daher, wie vorliegend geschehen, dem bereits tätig gewordenen Gutachter vorzulegen sind. Bei der Beantwortung der ihm gestellten Fragen verfügt der Facharzt über einen grossen Interpretationsspielraum, was für die Offenheit der Expertise spricht (vgl. dazu BGE 114 Ia 50 E. 3d S. 59 sowie Regina Kiener/Melanie Krüsi, a.a.O., S. 506 f.).
Für die hier in Frage stehende Konstellation der Vorbefassung ist festzuhalten, dass Dr. K._ nicht einzig deswegen als befangen abgelehnt werden kann, weil er das Gutachten vom 22. März 2004 verfasst hat. Es müssten hiefür bestimmte Umstände hinzukommen, die bei objektiver Betrachtung den Schluss auf Befangenheit zuliessen. Solche sind nicht zu ersehen. Es ist daher nicht zu beanstanden, dass die IV-Stelle Dr. K._ mit der nochmaligen Überarbeitung des psychiatrischen Gutachtens betraut hat. Denn es ist auch nach dem gerichtlichen Rückweisungsentscheid in erster Linie Sache der zuständigen Behörde, nach dem Untersuchungsgrundsatz die materielle Wahrheit zu ermitteln (vgl. Art. 43 Abs. 1 ATSG, Art. 57 IVG in Verbindung mit Art. 69 ff. IVV; BGE 132 V 93 E. 4 S. 99; SVR 2007 IV Nr. 22 S. 77, I 478/04). Erst die Vorlage des ergänzten Gutachtens wird Klarheit darüber erbringen, ob im Rahmen der freien Beweiswürdigung darauf abgestellt werden kann, oder ob sich die Einholung eines Zweitgutachtens aufdrängt. Der Fortgang des Abklärungsverfahrens bleibt somit offen. Das kantonale Gericht hat daher nicht Bundesrecht verletzt, wenn es geschlossen hat, die IV-Stelle habe die Rü-gen der Beschwerdeführerin in das Beweisverfahren verweisen dürfen, ohne eine Rechtsverweigerung zu begehen.
8. Die Vorinstanz hat die Beiordnung von Rechtsanwalt Dr. Pierre Heusser als unentgeltlichen Rechtsbeistand zufolge Aussichtslosigkeit der Beschwerde abgewiesen. Aufgrund der sich stellenden Rechtsfragen kann die Beschwerde vor kantonalem Gericht jedoch nicht als aussichtslos bezeichnet werden, und eine Vertretung durch einen Rechtsanwalt erwies sich als geboten. Zur Bedürftigkeit hat sich das kantonale Versicherungsgericht nicht geäussert. Diese erscheint indes aufgrund der Begründung des Gesuchs um unentgeltliche Rechtspflege für das bundesgerichtliche Verfahren und der eingereichten Beilagen als offensichtlich. Die Beschwerde ist daher bezüglich der unentgeltlichen Verbeiständung für das vorinstanzliche Verfahren gutzuheissen und die Sache zur Festsetzung der Entschädigung an das kantonale Gericht zurückzuweisen.
9. 9.1 In der Hauptsache sind die Gerichtskosten der Beschwerdeführerin als unterliegender Partei aufzuerlegen (Art. 66 Abs. 1 BGG). Ihrem Gesuch um unentgeltliche Rechtspflege für das bundesgerichtliche Verfahren ist stattzugeben, da die entsprechenden gesetzlichen Voraussetzungen erfüllt sind (Art. 64 Abs. 1 und 2 BGG). Es wird indessen ausdrücklich auf Art. 64 Abs. 4 BGG aufmerksam gemacht, wonach die begünstigte Partei der Gerichtskasse Ersatz zu leisten haben wird, wenn sie später dazu in der Lage ist.
9.2 Entsprechend seinem Ausgang sind im Beschwerdeverfahren um die unentgeltliche Verbeiständung für das vorinstanzliche Verfahren keine Kosten zu erheben (Art. 66 Abs. 4 BGG). Der Kanton Solothurn hat die Beschwerdeführerin für das bundesgerichtliche Verfahren mit Fr. 625.-- zu entschädigen (vgl. Urteile 8C_630/2007 vom 10. März 2008 und 5A_368/2007 vom 18. September 2007).
Demnach erkennt das Bundesgericht:
1. Die Beschwerde wird teilweise gutgeheissen. Ziffer 2 des Entscheids des Versicherungsgerichts des Kantons Solothurn vom 21. Februar 2007 wird aufgehoben. Rechtsanwalt Dr. Pierre Heusser, Zürich, wird als unentgeltlicher Anwalt der Beschwerdeführerin für das vorinstanzliche Verfahren bestellt. Die Sache wird zur Festsetzung seiner Entschädigung an die Vorinstanz zurückgewiesen. Im Übrigen wird die Beschwerde abgewiesen.
2. Der Beschwerdeführerin wird im bundesgerichtlichen Verfahren die unentgeltliche Rechtspflege gewährt.
3. Die Gerichtskosten von Fr. 400.-- werden der Beschwerdeführerin auferlegt, indes vorläufig auf die Gerichtskasse genommen.
4. Der Kanton Solothurn hat die Beschwerdeführerin für das bundesgerichtliche Verfahren mit Fr. 625.-- zu entschädigen.
5. Rechtsanwalt Dr. Pierre Heusser, Zürich, wird als unentgeltlicher Anwalt der Beschwerdeführerin bestellt, und es wird ihm für das bundesgerichtliche Verfahren aus der Gerichtskasse eine Entschädigung von Fr. 1'875.-- ausgerichtet.
6. Dieses Urteil wird den Parteien, der AHV-Ausgleichskasse Metzger, Bern, dem Versicherungsgericht des Kantons Solothurn und dem Bundesamt für Sozialversicherungen schriftlich mitgeteilt.
Luzern, 20. August 2008
Im Namen der I. sozialrechtlichen Abteilung
des Schweizerischen Bundesgerichts
Der Präsident: Die Gerichtsschreiberin:
Ursprung Hofer